database_controller.dart 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373
  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. late DatabaseViewCache _viewCache;
  74. // Callbacks
  75. DatabaseCallbacks? _databaseCallbacks;
  76. GroupCallbacks? _groupCallbacks;
  77. DatabaseLayoutSettingCallbacks? _layoutCallbacks;
  78. CalendarLayoutCallbacks? _calendarLayoutCallbacks;
  79. // Getters
  80. RowCache get rowCache => _viewCache.rowCache;
  81. // Listener
  82. final DatabaseGroupListener groupListener;
  83. final DatabaseLayoutSettingListener layoutListener;
  84. final DatabaseCalendarLayoutListener calendarLayoutListener;
  85. DatabaseController({required ViewPB view})
  86. : viewId = view.id,
  87. _databaseViewBackendSvc = DatabaseViewBackendService(viewId: view.id),
  88. fieldController = FieldController(viewId: view.id),
  89. groupListener = DatabaseGroupListener(view.id),
  90. layoutListener = DatabaseLayoutSettingListener(view.id),
  91. calendarLayoutListener = DatabaseCalendarLayoutListener(view.id) {
  92. _viewCache = DatabaseViewCache(
  93. viewId: viewId,
  94. fieldController: fieldController,
  95. );
  96. _listenOnRowsChanged();
  97. _listenOnFieldsChanged();
  98. _listenOnGroupChanged();
  99. _listenOnLayoutChanged();
  100. }
  101. void setListener({
  102. DatabaseCallbacks? onDatabaseChanged,
  103. DatabaseLayoutSettingCallbacks? onLayoutChanged,
  104. GroupCallbacks? onGroupChanged,
  105. CalendarLayoutCallbacks? onCalendarLayoutChanged,
  106. }) {
  107. _layoutCallbacks = onLayoutChanged;
  108. _databaseCallbacks = onDatabaseChanged;
  109. _groupCallbacks = onGroupChanged;
  110. _calendarLayoutCallbacks = onCalendarLayoutChanged;
  111. }
  112. Future<Either<Unit, FlowyError>> open() async {
  113. return _databaseViewBackendSvc.openGrid().then((result) {
  114. return result.fold(
  115. (database) async {
  116. databaseLayout = database.layoutType;
  117. if (databaseLayout == DatabaseLayoutPB.Calendar) {
  118. _listenOnCalendarLayoutChanged();
  119. }
  120. _databaseCallbacks?.onDatabaseChanged?.call(database);
  121. _viewCache.rowCache.setInitialRows(database.rows);
  122. return await fieldController
  123. .loadFields(
  124. fieldIds: database.fields,
  125. )
  126. .then(
  127. (result) {
  128. return result.fold(
  129. (l) => Future(() async {
  130. await _loadGroups();
  131. await _loadLayoutSetting();
  132. return left(l);
  133. }),
  134. (err) => right(err),
  135. );
  136. },
  137. );
  138. },
  139. (err) => right(err),
  140. );
  141. });
  142. }
  143. Future<Either<RowPB, FlowyError>> createRow({
  144. RowId? startRowId,
  145. String? groupId,
  146. void Function(RowDataBuilder builder)? withCells,
  147. }) {
  148. Map<String, String>? cellDataByFieldId;
  149. if (withCells != null) {
  150. final rowBuilder = RowDataBuilder();
  151. withCells(rowBuilder);
  152. cellDataByFieldId = rowBuilder.build();
  153. }
  154. return _databaseViewBackendSvc.createRow(
  155. startRowId: startRowId,
  156. groupId: groupId,
  157. cellDataByFieldId: cellDataByFieldId,
  158. );
  159. }
  160. Future<Either<Unit, FlowyError>> moveGroupRow({
  161. required RowPB fromRow,
  162. required String groupId,
  163. RowPB? toRow,
  164. }) {
  165. return _databaseViewBackendSvc.moveGroupRow(
  166. fromRowId: fromRow.id,
  167. toGroupId: groupId,
  168. toRowId: toRow?.id,
  169. );
  170. }
  171. Future<Either<Unit, FlowyError>> moveRow({
  172. required RowPB fromRow,
  173. required RowPB toRow,
  174. }) {
  175. return _databaseViewBackendSvc.moveRow(
  176. fromRowId: fromRow.id,
  177. toRowId: toRow.id,
  178. );
  179. }
  180. Future<Either<Unit, FlowyError>> moveGroup({
  181. required String fromGroupId,
  182. required String toGroupId,
  183. }) {
  184. return _databaseViewBackendSvc.moveGroup(
  185. fromGroupId: fromGroupId,
  186. toGroupId: toGroupId,
  187. );
  188. }
  189. Future<void> updateCalenderLayoutSetting(
  190. CalendarLayoutSettingPB layoutSetting,
  191. ) async {
  192. await _databaseViewBackendSvc
  193. .updateLayoutSetting(calendarLayoutSetting: layoutSetting)
  194. .then((result) {
  195. result.fold((l) => null, (r) => Log.error(r));
  196. });
  197. }
  198. Future<void> dispose() async {
  199. await _databaseViewBackendSvc.closeView();
  200. await fieldController.dispose();
  201. await groupListener.stop();
  202. await _viewCache.dispose();
  203. _databaseCallbacks = null;
  204. _groupCallbacks = null;
  205. _layoutCallbacks = null;
  206. _calendarLayoutCallbacks = null;
  207. }
  208. Future<void> _loadGroups() async {
  209. final result = await _databaseViewBackendSvc.loadGroups();
  210. return Future(
  211. () => result.fold(
  212. (groups) {
  213. _groupCallbacks?.onGroupByField?.call(groups.items);
  214. },
  215. (err) => Log.error(err),
  216. ),
  217. );
  218. }
  219. Future<void> _loadLayoutSetting() async {
  220. if (databaseLayout != null) {
  221. _databaseViewBackendSvc.getLayoutSetting(databaseLayout!).then((result) {
  222. result.fold(
  223. (l) => _layoutCallbacks?.onLoadLayout(l),
  224. (r) => Log.error(r),
  225. );
  226. });
  227. }
  228. }
  229. void _listenOnRowsChanged() {
  230. final callbacks = DatabaseViewCallbacks(
  231. onNumOfRowsChanged: (rows, rowByRowId, reason) {
  232. _databaseCallbacks?.onNumOfRowsChanged?.call(rows, rowByRowId, reason);
  233. },
  234. onRowsDeleted: (ids) {
  235. _databaseCallbacks?.onRowsDeleted?.call(ids);
  236. },
  237. onRowsUpdated: (ids) {
  238. _databaseCallbacks?.onRowsUpdated?.call(ids);
  239. },
  240. onRowsCreated: (ids) {
  241. _databaseCallbacks?.onRowsCreated?.call(ids);
  242. },
  243. );
  244. _viewCache.setListener(callbacks);
  245. }
  246. void _listenOnFieldsChanged() {
  247. fieldController.addListener(
  248. onReceiveFields: (fields) {
  249. _databaseCallbacks?.onFieldsChanged?.call(UnmodifiableListView(fields));
  250. },
  251. onFilters: (filters) {
  252. _databaseCallbacks?.onFiltersChanged?.call(filters);
  253. },
  254. );
  255. }
  256. void _listenOnGroupChanged() {
  257. groupListener.start(
  258. onNumOfGroupsChanged: (result) {
  259. result.fold(
  260. (changeset) {
  261. if (changeset.updateGroups.isNotEmpty) {
  262. _groupCallbacks?.onUpdateGroup?.call(changeset.updateGroups);
  263. }
  264. if (changeset.deletedGroups.isNotEmpty) {
  265. _groupCallbacks?.onDeleteGroup?.call(changeset.deletedGroups);
  266. }
  267. for (final insertedGroup in changeset.insertedGroups) {
  268. _groupCallbacks?.onInsertGroup?.call(insertedGroup);
  269. }
  270. },
  271. (r) => Log.error(r),
  272. );
  273. },
  274. onGroupByNewField: (result) {
  275. result.fold(
  276. (groups) {
  277. _groupCallbacks?.onGroupByField?.call(groups);
  278. },
  279. (r) => Log.error(r),
  280. );
  281. },
  282. );
  283. }
  284. void _listenOnLayoutChanged() {
  285. layoutListener.start(
  286. onLayoutChanged: (result) {
  287. result.fold(
  288. (l) {
  289. _layoutCallbacks?.onLayoutChanged(l);
  290. },
  291. (r) => Log.error(r),
  292. );
  293. },
  294. );
  295. }
  296. void _listenOnCalendarLayoutChanged() {
  297. calendarLayoutListener.start(
  298. onCalendarLayoutChanged: (result) {
  299. result.fold(
  300. (l) {
  301. _calendarLayoutCallbacks?.onCalendarLayoutChanged(l);
  302. },
  303. (r) => Log.error(r),
  304. );
  305. },
  306. );
  307. }
  308. }
  309. class RowDataBuilder {
  310. final _cellDataByFieldId = <String, String>{};
  311. void insertText(FieldInfo fieldInfo, String text) {
  312. assert(fieldInfo.fieldType == FieldType.RichText);
  313. _cellDataByFieldId[fieldInfo.field.id] = text;
  314. }
  315. void insertNumber(FieldInfo fieldInfo, int num) {
  316. assert(fieldInfo.fieldType == FieldType.Number);
  317. _cellDataByFieldId[fieldInfo.field.id] = num.toString();
  318. }
  319. void insertDate(FieldInfo fieldInfo, DateTime date) {
  320. assert(
  321. [
  322. FieldType.DateTime,
  323. FieldType.LastEditedTime,
  324. FieldType.CreatedTime,
  325. ].contains(fieldInfo.fieldType),
  326. );
  327. final timestamp = date.millisecondsSinceEpoch ~/ 1000;
  328. _cellDataByFieldId[fieldInfo.field.id] = timestamp.toString();
  329. }
  330. Map<String, String> build() {
  331. return _cellDataByFieldId;
  332. }
  333. }