database_controller.dart 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382
  1. import 'package:appflowy/plugins/database_view/application/field/field_controller.dart';
  2. import 'package:appflowy/plugins/database_view/application/layout/calendar_setting_listener.dart';
  3. import 'package:appflowy/plugins/database_view/application/view/view_cache.dart';
  4. import 'package:appflowy_backend/log.dart';
  5. import 'package:appflowy_backend/protobuf/flowy-database2/calendar_entities.pb.dart';
  6. import 'package:appflowy_backend/protobuf/flowy-database2/field_entities.pbenum.dart';
  7. import 'package:appflowy_backend/protobuf/flowy-database2/group.pb.dart';
  8. import 'package:appflowy_backend/protobuf/flowy-database2/group_changeset.pb.dart';
  9. import 'package:appflowy_backend/protobuf/flowy-database2/row_entities.pb.dart';
  10. import 'package:appflowy_backend/protobuf/flowy-database2/setting_entities.pb.dart';
  11. import 'package:appflowy_backend/protobuf/flowy-error/errors.pb.dart';
  12. import 'package:appflowy_backend/protobuf/flowy-folder2/view.pb.dart';
  13. import 'package:collection/collection.dart';
  14. import 'dart:async';
  15. import 'package:dartz/dartz.dart';
  16. import 'database_view_service.dart';
  17. import 'defines.dart';
  18. import 'layout/layout_setting_listener.dart';
  19. import 'row/row_cache.dart';
  20. import 'group/group_listener.dart';
  21. import 'row/row_service.dart';
  22. typedef OnGroupByField = void Function(List<GroupPB>);
  23. typedef OnUpdateGroup = void Function(List<GroupPB>);
  24. typedef OnDeleteGroup = void Function(List<String>);
  25. typedef OnInsertGroup = void Function(InsertedGroupPB);
  26. class GroupCallbacks {
  27. final OnGroupByField? onGroupByField;
  28. final OnUpdateGroup? onUpdateGroup;
  29. final OnDeleteGroup? onDeleteGroup;
  30. final OnInsertGroup? onInsertGroup;
  31. GroupCallbacks({
  32. this.onGroupByField,
  33. this.onUpdateGroup,
  34. this.onDeleteGroup,
  35. this.onInsertGroup,
  36. });
  37. }
  38. class DatabaseLayoutSettingCallbacks {
  39. final void Function(DatabaseLayoutSettingPB) onLayoutChanged;
  40. final void Function(DatabaseLayoutSettingPB) onLoadLayout;
  41. DatabaseLayoutSettingCallbacks({
  42. required this.onLayoutChanged,
  43. required this.onLoadLayout,
  44. });
  45. }
  46. class CalendarLayoutCallbacks {
  47. final void Function(DatabaseLayoutSettingPB) onCalendarLayoutChanged;
  48. CalendarLayoutCallbacks({required this.onCalendarLayoutChanged});
  49. }
  50. class DatabaseCallbacks {
  51. OnDatabaseChanged? onDatabaseChanged;
  52. OnFieldsChanged? onFieldsChanged;
  53. OnFiltersChanged? onFiltersChanged;
  54. OnNumOfRowsChanged? onNumOfRowsChanged;
  55. OnRowsDeleted? onRowsDeleted;
  56. OnRowsUpdated? onRowsUpdated;
  57. OnRowsCreated? onRowsCreated;
  58. DatabaseCallbacks({
  59. this.onDatabaseChanged,
  60. this.onNumOfRowsChanged,
  61. this.onFieldsChanged,
  62. this.onFiltersChanged,
  63. this.onRowsUpdated,
  64. this.onRowsDeleted,
  65. this.onRowsCreated,
  66. });
  67. }
  68. class DatabaseController {
  69. final String viewId;
  70. final DatabaseViewBackendService _databaseViewBackendSvc;
  71. final FieldController fieldController;
  72. DatabaseLayoutPB? databaseLayout;
  73. DatabaseLayoutSettingPB? databaseLayoutSetting;
  74. late DatabaseViewCache _viewCache;
  75. // Callbacks
  76. DatabaseCallbacks? _databaseCallbacks;
  77. GroupCallbacks? _groupCallbacks;
  78. DatabaseLayoutSettingCallbacks? _layoutCallbacks;
  79. CalendarLayoutCallbacks? _calendarLayoutCallbacks;
  80. // Getters
  81. RowCache get rowCache => _viewCache.rowCache;
  82. // Listener
  83. final DatabaseGroupListener _groupListener;
  84. final DatabaseLayoutSettingListener _layoutListener;
  85. final DatabaseCalendarLayoutListener _calendarLayoutListener;
  86. DatabaseController({required ViewPB view})
  87. : viewId = view.id,
  88. _databaseViewBackendSvc = DatabaseViewBackendService(viewId: view.id),
  89. fieldController = FieldController(viewId: view.id),
  90. _groupListener = DatabaseGroupListener(view.id),
  91. _layoutListener = DatabaseLayoutSettingListener(view.id),
  92. _calendarLayoutListener = DatabaseCalendarLayoutListener(view.id) {
  93. _viewCache = DatabaseViewCache(
  94. viewId: viewId,
  95. fieldController: fieldController,
  96. );
  97. _listenOnRowsChanged();
  98. _listenOnFieldsChanged();
  99. _listenOnGroupChanged();
  100. _listenOnLayoutChanged();
  101. }
  102. void setListener({
  103. DatabaseCallbacks? onDatabaseChanged,
  104. DatabaseLayoutSettingCallbacks? onLayoutChanged,
  105. GroupCallbacks? onGroupChanged,
  106. CalendarLayoutCallbacks? onCalendarLayoutChanged,
  107. }) {
  108. _layoutCallbacks = onLayoutChanged;
  109. _databaseCallbacks = onDatabaseChanged;
  110. _groupCallbacks = onGroupChanged;
  111. _calendarLayoutCallbacks = onCalendarLayoutChanged;
  112. }
  113. Future<Either<Unit, FlowyError>> open() async {
  114. return _databaseViewBackendSvc.openGrid().then((result) {
  115. return result.fold(
  116. (database) async {
  117. databaseLayout = database.layoutType;
  118. if (databaseLayout == DatabaseLayoutPB.Calendar) {
  119. _listenOnCalendarLayoutChanged();
  120. }
  121. _databaseCallbacks?.onDatabaseChanged?.call(database);
  122. _viewCache.rowCache.setInitialRows(database.rows);
  123. return await fieldController
  124. .loadFields(
  125. fieldIds: database.fields,
  126. )
  127. .then(
  128. (result) {
  129. return result.fold(
  130. (l) => Future(() async {
  131. await _loadGroups();
  132. await _loadLayoutSetting();
  133. return left(l);
  134. }),
  135. (err) => right(err),
  136. );
  137. },
  138. );
  139. },
  140. (err) => right(err),
  141. );
  142. });
  143. }
  144. Future<Either<RowPB, FlowyError>> createRow({
  145. RowId? startRowId,
  146. String? groupId,
  147. void Function(RowDataBuilder builder)? withCells,
  148. }) {
  149. Map<String, String>? cellDataByFieldId;
  150. if (withCells != null) {
  151. final rowBuilder = RowDataBuilder();
  152. withCells(rowBuilder);
  153. cellDataByFieldId = rowBuilder.build();
  154. }
  155. return _databaseViewBackendSvc.createRow(
  156. startRowId: startRowId,
  157. groupId: groupId,
  158. cellDataByFieldId: cellDataByFieldId,
  159. );
  160. }
  161. Future<Either<Unit, FlowyError>> moveGroupRow({
  162. required RowPB fromRow,
  163. required String groupId,
  164. RowPB? toRow,
  165. }) {
  166. return _databaseViewBackendSvc.moveGroupRow(
  167. fromRowId: fromRow.id,
  168. toGroupId: groupId,
  169. toRowId: toRow?.id,
  170. );
  171. }
  172. Future<Either<Unit, FlowyError>> moveRow({
  173. required RowPB fromRow,
  174. required RowPB toRow,
  175. }) {
  176. return _databaseViewBackendSvc.moveRow(
  177. fromRowId: fromRow.id,
  178. toRowId: toRow.id,
  179. );
  180. }
  181. Future<Either<Unit, FlowyError>> moveGroup({
  182. required String fromGroupId,
  183. required String toGroupId,
  184. }) {
  185. return _databaseViewBackendSvc.moveGroup(
  186. fromGroupId: fromGroupId,
  187. toGroupId: toGroupId,
  188. );
  189. }
  190. Future<void> updateCalenderLayoutSetting(
  191. CalendarLayoutSettingPB layoutSetting,
  192. ) async {
  193. await _databaseViewBackendSvc
  194. .updateLayoutSetting(calendarLayoutSetting: layoutSetting)
  195. .then((result) {
  196. result.fold((l) => null, (r) => Log.error(r));
  197. });
  198. }
  199. Future<void> dispose() async {
  200. await _databaseViewBackendSvc.closeView();
  201. await fieldController.dispose();
  202. await _groupListener.stop();
  203. await _viewCache.dispose();
  204. _databaseCallbacks = null;
  205. _groupCallbacks = null;
  206. _layoutCallbacks = null;
  207. _calendarLayoutCallbacks = null;
  208. }
  209. Future<void> _loadGroups() async {
  210. final result = await _databaseViewBackendSvc.loadGroups();
  211. return Future(
  212. () => result.fold(
  213. (groups) {
  214. _groupCallbacks?.onGroupByField?.call(groups.items);
  215. },
  216. (err) => Log.error(err),
  217. ),
  218. );
  219. }
  220. Future<void> _loadLayoutSetting() async {
  221. if (databaseLayout != null) {
  222. _databaseViewBackendSvc.getLayoutSetting(databaseLayout!).then((result) {
  223. result.fold(
  224. (newDatabaseLayoutSetting) {
  225. databaseLayoutSetting = newDatabaseLayoutSetting;
  226. databaseLayoutSetting?.freeze();
  227. _layoutCallbacks?.onLoadLayout(newDatabaseLayoutSetting);
  228. },
  229. (r) => Log.error(r),
  230. );
  231. });
  232. }
  233. }
  234. void _listenOnRowsChanged() {
  235. final callbacks = DatabaseViewCallbacks(
  236. onNumOfRowsChanged: (rows, rowByRowId, reason) {
  237. _databaseCallbacks?.onNumOfRowsChanged?.call(rows, rowByRowId, reason);
  238. },
  239. onRowsDeleted: (ids) {
  240. _databaseCallbacks?.onRowsDeleted?.call(ids);
  241. },
  242. onRowsUpdated: (ids) {
  243. _databaseCallbacks?.onRowsUpdated?.call(ids);
  244. },
  245. onRowsCreated: (ids) {
  246. _databaseCallbacks?.onRowsCreated?.call(ids);
  247. },
  248. );
  249. _viewCache.setListener(callbacks);
  250. }
  251. void _listenOnFieldsChanged() {
  252. fieldController.addListener(
  253. onReceiveFields: (fields) {
  254. _databaseCallbacks?.onFieldsChanged?.call(UnmodifiableListView(fields));
  255. },
  256. onFilters: (filters) {
  257. _databaseCallbacks?.onFiltersChanged?.call(filters);
  258. },
  259. );
  260. }
  261. void _listenOnGroupChanged() {
  262. _groupListener.start(
  263. onNumOfGroupsChanged: (result) {
  264. result.fold(
  265. (changeset) {
  266. if (changeset.updateGroups.isNotEmpty) {
  267. _groupCallbacks?.onUpdateGroup?.call(changeset.updateGroups);
  268. }
  269. if (changeset.deletedGroups.isNotEmpty) {
  270. _groupCallbacks?.onDeleteGroup?.call(changeset.deletedGroups);
  271. }
  272. for (final insertedGroup in changeset.insertedGroups) {
  273. _groupCallbacks?.onInsertGroup?.call(insertedGroup);
  274. }
  275. },
  276. (r) => Log.error(r),
  277. );
  278. },
  279. onGroupByNewField: (result) {
  280. result.fold(
  281. (groups) {
  282. _groupCallbacks?.onGroupByField?.call(groups);
  283. },
  284. (r) => Log.error(r),
  285. );
  286. },
  287. );
  288. }
  289. void _listenOnLayoutChanged() {
  290. _layoutListener.start(
  291. onLayoutChanged: (result) {
  292. result.fold(
  293. (newDatabaseLayoutSetting) {
  294. databaseLayoutSetting = newDatabaseLayoutSetting;
  295. databaseLayoutSetting?.freeze();
  296. _layoutCallbacks?.onLayoutChanged(newDatabaseLayoutSetting);
  297. },
  298. (r) => Log.error(r),
  299. );
  300. },
  301. );
  302. }
  303. void _listenOnCalendarLayoutChanged() {
  304. _calendarLayoutListener.start(
  305. onCalendarLayoutChanged: (result) {
  306. result.fold(
  307. (l) {
  308. _calendarLayoutCallbacks?.onCalendarLayoutChanged(l);
  309. },
  310. (r) => Log.error(r),
  311. );
  312. },
  313. );
  314. }
  315. }
  316. class RowDataBuilder {
  317. final _cellDataByFieldId = <String, String>{};
  318. void insertText(FieldInfo fieldInfo, String text) {
  319. assert(fieldInfo.fieldType == FieldType.RichText);
  320. _cellDataByFieldId[fieldInfo.field.id] = text;
  321. }
  322. void insertNumber(FieldInfo fieldInfo, int num) {
  323. assert(fieldInfo.fieldType == FieldType.Number);
  324. _cellDataByFieldId[fieldInfo.field.id] = num.toString();
  325. }
  326. void insertDate(FieldInfo fieldInfo, DateTime date) {
  327. assert(
  328. [
  329. FieldType.DateTime,
  330. FieldType.LastEditedTime,
  331. FieldType.CreatedTime,
  332. ].contains(fieldInfo.fieldType),
  333. );
  334. final timestamp = date.millisecondsSinceEpoch ~/ 1000;
  335. _cellDataByFieldId[fieldInfo.field.id] = timestamp.toString();
  336. }
  337. Map<String, String> build() {
  338. return _cellDataByFieldId;
  339. }
  340. }