Refactor/database (#1220)

uni/lib/controller/local_storage/database/app_bus_stop_database.dart

@@ -10,12 +10,15 @@ import 'package:uni/model/entities/bus_stop.dart';
 /// This database stores information about the bus stops that the user
 /// wants to keep track of. It also stores information about
 /// which ones are the user's favorite stops.
-class AppBusStopDatabase extends AppDatabase {
+class AppBusStopDatabase extends AppDatabase<Map<String, BusStopData>> {
   AppBusStopDatabase()
-      : super('busstops.db', [
-          'CREATE TABLE busstops(stopCode TEXT, busCode TEXT)',
-          'CREATE TABLE favoritestops(stopCode TEXT, favorited TEXT)',
-        ]);
+      : super(
+          'busstops.db',
+          [
+            'CREATE TABLE busstops(stopCode TEXT, busCode TEXT)',
+            'CREATE TABLE favoritestops(stopCode TEXT, favorited TEXT)',
+          ],
+        );
 
   /// Returns a map containing all the data stored in this database.
   ///
@@ -103,9 +106,10 @@ class AppBusStopDatabase extends AppDatabase {
   }
 
   /// Replaces all the bus stops in this database with entries
-  /// from [stops].
-  Future<void> setBusStops(Map<String, BusStopData> stops) async {
+  /// from [data].
+  @override
+  Future<void> saveToDatabase(Map<String, BusStopData> data) async {
     await deleteBusStops();
-    await _insertBusStops(stops);
+    await _insertBusStops(data);
   }
 }

uni/lib/controller/local_storage/database/app_calendar_database.dart

@@ -1,25 +1,18 @@
 import 'package:uni/controller/local_storage/database/app_database.dart';
 import 'package:uni/model/entities/calendar_event.dart';
 
-class CalendarDatabase extends AppDatabase {
+class CalendarDatabase extends AppDatabase<List<CalendarEvent>> {
   CalendarDatabase()
-      : super('calendar.bd', [
-          '''
+      : super(
+          'calendar.bd',
+          [
+            '''
           CREATE TABLE CALENDAR(
             id INTEGER PRIMARY KEY AUTOINCREMENT,
             name TEXT,
             date TEXT)'''
-        ]);
-
-  Future<void> saveCalendar(List<CalendarEvent> calendar) async {
-    final db = await getDatabase();
-    await db.transaction((txn) async {
-      await txn.delete('CALENDAR');
-      for (final event in calendar) {
-        await txn.insert('CALENDAR', event.toMap());
-      }
-    });
-  }
+          ],
+        );
 
   // Returns a list with all calendar events stored in the database
   Future<List<CalendarEvent>> calendar() async {
@@ -34,4 +27,15 @@ class CalendarDatabase extends AppDatabase {
       );
     });
   }
+
+  @override
+  Future<void> saveToDatabase(List<CalendarEvent> data) async {
+    final db = await getDatabase();
+    await db.transaction((txn) async {
+      await txn.delete('CALENDAR');
+      for (final event in data) {
+        await txn.insert('CALENDAR', event.toMap());
+      }
+    });
+  }
 }

uni/lib/controller/local_storage/database/app_course_units_database.dart

@@ -4,19 +4,18 @@ import 'package:sqflite/sqflite.dart';
 import 'package:uni/controller/local_storage/database/app_database.dart';
 import 'package:uni/model/entities/course_units/course_unit.dart';
 
-class AppCourseUnitsDatabase extends AppDatabase {
-  AppCourseUnitsDatabase() : super('course_units.db', [createScript]);
+class AppCourseUnitsDatabase extends AppDatabase<List<CourseUnit>> {
+  AppCourseUnitsDatabase()
+      : super(
+          'course_units.db',
+          [createScript],
+        );
   static const String createScript =
       '''CREATE TABLE course_units(id INTEGER, code TEXT, abbreviation TEXT , '''
       '''name TEXT, curricularYear INTEGER, occurrId INTEGER, semesterCode TEXT, '''
       '''semesterName TEXT, type TEXT, status TEXT, grade TEXT, ectsGrade TEXT, '''
       '''result TEXT, ects REAL, schoolYear TEXT)''';
 
-  Future<void> saveNewCourseUnits(List<CourseUnit> courseUnits) async {
-    await deleteCourseUnits();
-    await _insertCourseUnits(courseUnits);
-  }
-
   Future<List<CourseUnit>> courseUnits() async {
     final db = await getDatabase();
     final List<Map<String, dynamic>> maps = await db.query('course_units');
@@ -56,4 +55,10 @@ class AppCourseUnitsDatabase extends AppDatabase {
     final db = await getDatabase();
     await db.delete('course_units');
   }
+
+  @override
+  Future<void> saveToDatabase(List<CourseUnit> data) async {
+    await deleteCourseUnits();
+    await _insertCourseUnits(data);
+  }
 }

uni/lib/controller/local_storage/database/app_courses_database.dart

@@ -8,20 +8,19 @@ import 'package:uni/model/entities/course.dart';
 ///
 /// This database stores information about the user's courses.
 /// See the [Course] class to see what data is stored in this database.
-class AppCoursesDatabase extends AppDatabase {
+class AppCoursesDatabase extends AppDatabase<List<Course>> {
   AppCoursesDatabase()
-      : super('courses.db', [createScript], onUpgrade: migrate, version: 3);
+      : super(
+          'courses.db',
+          [createScript],
+          onUpgrade: migrate,
+          version: 3,
+        );
   static const String createScript =
       '''CREATE TABLE courses(id INTEGER, fest_id INTEGER, name TEXT, '''
       '''abbreviation TEXT, currYear TEXT, firstEnrollment INTEGER, state TEXT, '''
       '''faculty TEXT, currentAverage REAL, finishedEcts REAL)''';
 
-  /// Replaces all of the data in this database with the data from [courses].
-  Future<void> saveNewCourses(List<Course> courses) async {
-    await deleteCourses();
-    await _insertCourses(courses);
-  }
-
   /// Returns a list containing all of the courses stored in this database.
   Future<List<Course>> courses() async {
     final db = await getDatabase();
@@ -77,4 +76,11 @@ class AppCoursesDatabase extends AppDatabase {
       ..execute(createScript);
     await batch.commit();
   }
+
+  /// Replaces all of the data in this database with the data from [data].
+  @override
+  Future<void> saveToDatabase(List<Course> data) async {
+    await deleteCourses();
+    await _insertCourses(data);
+  }
 }

uni/lib/controller/local_storage/database/app_database.dart

@@ -1,15 +1,19 @@
-import 'dart:async';
-
 import 'package:path/path.dart';
 import 'package:path_provider/path_provider.dart';
 import 'package:sqflite/sqflite.dart';
 import 'package:synchronized/synchronized.dart';
+import 'package:uni/controller/local_storage/preferences_controller.dart';
 
 /// Manages a generic database.
 ///
 /// This class is the foundation for all other database managers.
-class AppDatabase {
-  AppDatabase(this.name, this.commands, {this.onUpgrade, this.version = 1});
+abstract class AppDatabase<T> {
+  AppDatabase(
+    this.name,
+    this.commands, {
+    this.onUpgrade,
+    this.version = 1,
+  });
 
   /// An instance of this database.
   Database? _db;
@@ -20,6 +24,9 @@ class AppDatabase {
   /// A list of commands to be executed on database creation.
   List<String> commands;
 
+  /// Whether the session is persistent or not.
+  bool? _persistentSession;
+
   /// The lock timeout for database operations.
   static const Duration lockTimeout = Duration(seconds: 5);
 
@@ -32,12 +39,28 @@ class AppDatabase {
   /// The version of this database.
   final int version;
 
+  /// Getter to determine if the session is persistent.
+  Future<bool> get persistentSession async {
+    _persistentSession ??=
+        await PreferencesController.getPersistentUserInfo() != null;
+    return _persistentSession!;
+  }
+
   /// Returns an instance of this database.
   Future<Database> getDatabase() async {
     _db ??= await initializeDatabase();
     return _db!;
   }
 
+  Future<void> saveToDatabase(T data);
+
+  /// Calls saveToDatabase if the session is persistent
+  Future<void> saveIfPersistentSession(T data) async {
+    if (await persistentSession) {
+      await saveToDatabase(data);
+    }
+  }
+
   /// Inserts [values] into the corresponding [table] in this database.
   Future<void> insertInDatabase(
     String table,

uni/lib/controller/local_storage/database/app_exams_database.dart

@@ -8,20 +8,19 @@ import 'package:uni/model/entities/exam.dart';
 ///
 /// This database stores information about the user's exams.
 /// See the [Exam] class to see what data is stored in this database.
-class AppExamsDatabase extends AppDatabase {
+class AppExamsDatabase extends AppDatabase<List<Exam>> {
   AppExamsDatabase()
-      : super('exams.db', [_createScript], onUpgrade: migrate, version: 5);
+      : super(
+          'exams.db',
+          [_createScript],
+          onUpgrade: migrate,
+          version: 5,
+        );
 
   static const _createScript = '''
 CREATE TABLE exams(id TEXT, subject TEXT, begin TEXT, end TEXT,
           rooms TEXT, examType TEXT, faculty TEXT, PRIMARY KEY (id,faculty)) ''';
 
-  /// Replaces all of the data in this database with [exams].
-  Future<void> saveNewExams(List<Exam> exams) async {
-    await deleteExams();
-    await _insertExams(exams);
-  }
-
   /// Returns a list containing all of the exams stored in this database.
   Future<List<Exam>> exams() async {
     final db = await getDatabase();
@@ -70,4 +69,11 @@ CREATE TABLE exams(id TEXT, subject TEXT, begin TEXT, end TEXT,
       ..execute(_createScript);
     await batch.commit();
   }
+
+  /// Replaces all of the data in this database with [data].
+  @override
+  Future<void> saveToDatabase(List<Exam> data) async {
+    await deleteExams();
+    await _insertExams(data);
+  }
 }

uni/lib/controller/local_storage/database/app_last_user_info_update_database.dart

@@ -4,15 +4,12 @@ import 'package:uni/controller/local_storage/database/app_database.dart';
 ///
 /// This database stores information about when the app last fetched and updated
 /// the user's data.
-class AppLastUserInfoUpdateDatabase extends AppDatabase {
+class AppLastUserInfoUpdateDatabase extends AppDatabase<DateTime> {
   AppLastUserInfoUpdateDatabase()
-      : super('last_update.db', ['CREATE TABLE last_update(lastUpdate DATE)']);
-
-  /// Replaces the timestamp in this database with [timestamp].
-  Future<void> insertNewTimeStamp(DateTime timestamp) async {
-    await deleteLastUpdate();
-    await _insertTimeStamp(timestamp);
-  }
+      : super(
+          'last_update.db',
+          ['CREATE TABLE last_update(lastUpdate DATE)'],
+        );
 
   /// Deletes all of the data from this database.
   Future<void> deleteLastUpdate() async {
@@ -41,4 +38,11 @@ class AppLastUserInfoUpdateDatabase extends AppDatabase {
     }
     return DateTime.now();
   }
+
+  /// Replaces the timestamp in this database with [data].
+  @override
+  Future<void> saveToDatabase(DateTime data) async {
+    await deleteLastUpdate();
+    await _insertTimeStamp(data);
+  }
 }

uni/lib/controller/local_storage/database/app_lectures_database.dart

@@ -8,7 +8,7 @@ import 'package:uni/model/entities/lecture.dart';
 ///
 /// This database stores information about the user's lectures.
 /// See the [Lecture] class to see what data is stored in this database.
-class AppLecturesDatabase extends AppDatabase {
+class AppLecturesDatabase extends AppDatabase<List<Lecture>> {
   AppLecturesDatabase()
       : super(
           'lectures.db',
@@ -22,12 +22,6 @@ class AppLecturesDatabase extends AppDatabase {
 CREATE TABLE lectures(subject TEXT, typeClass TEXT,
           startDateTime TEXT, blocks INTEGER, room TEXT, teacher TEXT, classNumber TEXT, occurrId INTEGER)''';
 
-  /// Replaces all of the data in this database with [lectures].
-  Future<void> saveNewLectures(List<Lecture> lectures) async {
-    await deleteLectures();
-    await _insertLectures(lectures);
-  }
-
   /// Returns a list containing all of the lectures stored in this database.
   Future<List<Lecture>> lectures() async {
     final db = await getDatabase();
@@ -82,4 +76,11 @@ CREATE TABLE lectures(subject TEXT, typeClass TEXT,
       ..execute(createScript);
     await batch.commit();
   }
+
+  /// Replaces all of the data in this database with [lectures].
+  @override
+  Future<void> saveToDatabase(List<Lecture> data) async {
+    await deleteLectures();
+    await _insertLectures(data);
+  }
 }

uni/lib/controller/local_storage/database/app_library_occupation_database.dart

@@ -1,28 +1,21 @@
 import 'package:uni/controller/local_storage/database/app_database.dart';
 import 'package:uni/model/entities/library_occupation.dart';
 
-class LibraryOccupationDatabase extends AppDatabase {
+class LibraryOccupationDatabase extends AppDatabase<LibraryOccupation> {
   LibraryOccupationDatabase()
-      : super('occupation.db', [
-          '''
-CREATE TABLE FLOOR_OCCUPATION(
-        id INTEGER PRIMARY KEY AUTOINCREMENT,
-        number INT,
-        occupation INT,
-        capacity INT
-      )
-      '''
-        ]);
-
-  Future<void> saveOccupation(LibraryOccupation occupation) async {
-    final db = await getDatabase();
-    await db.transaction((txn) async {
-      await txn.delete('FLOOR_OCCUPATION');
-      for (final floor in occupation.floors) {
-        await txn.insert('FLOOR_OCCUPATION', floor.toMap());
-      }
-    });
-  }
+      : super(
+          'occupation.db',
+          [
+            '''
+              CREATE TABLE FLOOR_OCCUPATION(
+              id INTEGER PRIMARY KEY AUTOINCREMENT,
+              number INT,
+              occupation INT,
+              capacity INT
+              )
+              '''
+          ],
+        );
 
   Future<LibraryOccupation> occupation() async {
     final db = await getDatabase();
@@ -43,4 +36,15 @@ CREATE TABLE FLOOR_OCCUPATION(
 
     return occupation;
   }
+
+  @override
+  Future<void> saveToDatabase(LibraryOccupation data) async {
+    final db = await getDatabase();
+    await db.transaction((txn) async {
+      await txn.delete('FLOOR_OCCUPATION');
+      for (final floor in data.floors) {
+        await txn.insert('FLOOR_OCCUPATION', floor.toMap());
+      }
+    });
+  }
 }