database_controller.dart 10 KB

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