Merge pull request #33 from LEIC-ES-2021-22/release

Iteration 2

Author: jlcrodrigues

app_feup/.gitignore

@@ -83,3 +83,4 @@ lib/generated_plugin_registrant.dart
 
 # Exceptions to above rules.
 !/packages/flutter_tools/test/data/dart_dependencies_test/**/.packages
+assets/auth/key.json

app_feup/lib/controller/load_info.dart

@@ -56,14 +56,18 @@ Future loadRemoteUserInfoToState(Store<AppState> store) async {
       coursesStates = Completer(),
       trips = Completer(),
       lastUpdate = Completer(),
-      restaurants = Completer();
+      restaurants = Completer(),
+      occupation = Completer(),
+      reservations = Completer();
 
   store.dispatch(getUserInfo(userInfo));
   store.dispatch(getUserPrintBalance(printBalance));
   store.dispatch(getUserFees(fees));
   store.dispatch(getUserCoursesState(coursesStates));
   store.dispatch(getUserBusTrips(trips));
   store.dispatch(getRestaurantsFromFetcher(restaurants));
+  store.dispatch(getOccupationFromFetcher(occupation));
+  store.dispatch(getReservationsFromFetcher(reservations));
 
   final Tuple2<String, String> userPersistentInfo =
       await AppSharedPreferences.getPersistentUserInfo();
@@ -80,7 +84,9 @@ Future loadRemoteUserInfoToState(Store<AppState> store) async {
     coursesStates.future,
     userInfo.future,
     trips.future,
-    restaurants.future
+    restaurants.future,
+    occupation.future,
+    reservations.future
   ]);
   allRequests.then((futures) {
     store.dispatch(setLastUserInfoUpdateTimestamp(lastUpdate));

app_feup/lib/controller/local_storage/app_library_occupation_database.dart

@@ -0,0 +1,27 @@
+import 'package:uni/model/entities/library.dart';
+
+import 'app_database.dart';
+
+class OccupationDatabase extends AppDatabase {
+  OccupationDatabase()
+    : super('occupation.db', 
+    [
+      '''CREATE TABLE FLOOR_OCCUPATION(
+        id INTEGER PRIMARY KEY AUTOINCREMENT,
+        number INT,
+        occupation INT,
+        capacity INT
+      )
+      '''
+    ]);
+
+  void saveOccupation(LibraryOccupation occupation) async {
+    final db = await this.getDatabase();
+    db.transaction((txn) async {
+      await txn.delete('FLOOR_OCCUPATION');
+      occupation.getFloors().forEach((floor) async { 
+        await txn.insert('FLOOR_OCCUPATION', floor.toMap());
+      });
+    });
+  }
+}

app_feup/lib/controller/local_storage/app_reservations_database.dart

@@ -0,0 +1,27 @@
+import 'package:uni/model/entities/reservation.dart';
+
+import 'app_database.dart';
+
+class ReservationDatabase extends AppDatabase {
+  ReservationDatabase()
+    : super('reservations.db', 
+    [
+      '''CREATE TABLE RESERVATION(
+        id INTEGER PRIMARY KEY AUTOINCREMENT,
+        room TEXT,
+        startDate INT,
+        duration INT
+      )
+      '''
+    ]);
+
+  void saveReservations(List<Reservation> reservations) async {
+    final db = await this.getDatabase();
+    db.transaction((txn) async {
+      await txn.delete('RESERVATION');
+      reservations.forEach((reservation) async { 
+        await txn.insert('RESERVATION', reservation.toMap());
+      });
+    });
+  }
+}

app_feup/lib/controller/local_storage/app_shared_preferences.dart

@@ -26,7 +26,8 @@ class AppSharedPreferences {
     FAVORITE_WIDGET_TYPE.schedule,
     FAVORITE_WIDGET_TYPE.exams,
     FAVORITE_WIDGET_TYPE.busStops,
-    FAVORITE_WIDGET_TYPE.libraryOccupation
+    FAVORITE_WIDGET_TYPE.libraryOccupation,
+    FAVORITE_WIDGET_TYPE.roomReservations
   ];
   static final String filteredExamsTypes = 'filtered_exam_types';
   static final List<String> defaultFilteredExamTypes =

app_feup/lib/controller/occupation_fetcher/occupation_fetcher_sheets.dart

@@ -0,0 +1,31 @@
+import 'dart:convert';
+import 'package:flutter/services.dart';
+import 'package:uni/model/app_state.dart';
+import 'package:redux/redux.dart';
+import 'package:uni/model/entities/library.dart';
+import 'package:uni/controller/parsers/parser_occupation.dart';
+import 'package:gsheets/gsheets.dart';
+
+Future<String> getJson() {
+  return rootBundle.loadString('assets/auth/key.json');
+}
+
+/// Fetch the school calendar from Google Sheets
+class OccupationFetcherSheets {
+  Future<LibraryOccupation> getOccupationFromSheets (
+      Store<AppState> store) async {
+    final sheetId = '1gZRbEX4y8vNW7vrl15FCdAQ3pVNRJw_uRZtVL6ORP0g';
+
+    try {
+      final googleCredentials =  json.decode(await getJson());
+      final gSheets = GSheets(googleCredentials);
+      final ss = await gSheets.spreadsheet(sheetId);
+
+      final sheet = ss.worksheetByTitle('MANUAL');
+
+      return getOccupationFromSheet(sheet);
+    } catch (FlutterError) {
+      return LibraryOccupation();
+    }
+  }
+} 

app_feup/lib/controller/parsers/parser_occupation.dart

@@ -0,0 +1,19 @@
+import 'package:uni/model/entities/library.dart';
+import 'package:gsheets/gsheets.dart';
+
+Future<LibraryOccupation> getOccupationFromSheet(Worksheet sheet) async {
+  try {
+    final occupation = LibraryOccupation();
+
+    for (int i = 1; i < 7; i++) {
+      final occupationCell = await sheet.cells.cell(column: 3, row: i + 1);
+      final capacityCell = await sheet.cells.cell(column: 5, row: i + 1);
+
+      occupation.addFloor(FloorOccupation(
+          i, int.parse(occupationCell.value), int.parse(capacityCell.value)));
+    }
+    return occupation;
+  } catch (FormatException) {
+    return LibraryOccupation();
+  }
+}

app_feup/lib/controller/parsers/parser_reservation.dart

@@ -0,0 +1,24 @@
+import 'package:http/http.dart';
+import 'package:html/dom.dart';
+import 'package:html/parser.dart';
+import 'package:uni/model/entities/reservation.dart';
+
+Future<List<Reservation>> getReservationsFromHtml(Response response) async {
+  final document = parse(response.body);
+
+  final List<Element> reservationHtml =
+    document.getElementsByClassName('d interior');
+
+  return reservationHtml.map( (element) {
+    final String room = element.children[5].firstChild.text;
+    final String date = element.children[0].firstChild.text;
+    final String hour = element.children[2].firstChild.text;
+    final DateTime startDate = DateTime.parse('$date $hour');
+    final String durationHtml = element.children[4].firstChild.text;
+    final Duration duration = Duration(
+      hours: int.parse(durationHtml.substring(0,2)),
+      minutes: int.parse(durationHtml.substring(3,5))
+      );
+    return Reservation(room, startDate, duration);
+  }).toList();
+}

app_feup/lib/controller/reservations_fetcher/reservations_fetcher_html.dart

@@ -0,0 +1,25 @@
+
+import 'package:http/http.dart';
+import 'package:uni/controller/networking/network_router.dart';
+import 'package:uni/controller/parsers/parser_reservation.dart';
+import 'package:uni/model/app_state.dart';
+import 'package:uni/model/entities/reservation.dart';
+import 'package:uni/model/entities/session.dart';
+import 'package:redux/redux.dart';
+
+/// Get the library rooms' reservations from the website
+class ReservationsFetcherHtml {
+  Future<List<Reservation>> getReservations(Store<AppState> store) async {
+
+    final String baseUrl = NetworkRouter.getBaseUrlFromSession(
+        store.state.content['session']) +
+        'res_recursos_geral.pedidos_list?pct_tipo_grupo_id=3';
+    final Session session = store.state.content['session'];
+    final Future<Response> response = NetworkRouter.getWithCookies(baseUrl,
+        {}, session);
+    final List<Reservation> reservations =
+          await response.then((response) => getReservationsFromHtml(response));
+
+    return reservations;
+  }
+}

app_feup/lib/main.dart

@@ -18,6 +18,7 @@ import 'package:uni/view/Pages/home_page_view.dart';
 import 'package:uni/view/Pages/logout_route.dart';
 import 'package:uni/view/Pages/splash_page_view.dart';
 import 'package:uni/view/Pages/uniteca_page_view.dart';
+import 'package:uni/view/Pages/room_reservations_page_view.dart';
 import 'package:uni/view/Widgets/page_transition.dart';
 import 'package:uni/view/navigation_service.dart';
 import 'package:uni/view/theme.dart';
@@ -106,6 +107,10 @@ class MyAppState extends State<MyApp> {
                 return PageTransition.makePageTransition(
                     page: UnitecaPageView(), settings: settings
                 );
+                case '/' + Constants.navRooms:
+                return PageTransition.makePageTransition(
+                    page: RoomReservationsPageView(), settings: settings
+                );
               case '/' + Constants.navLogOut:
                 return LogoutRoute.buildLogoutRoute();
             }

app_feup/lib/model/app_state.dart

@@ -1,12 +1,14 @@
 // enum should be placed somewhere else?
 import 'package:uni/model/entities/bus_stop.dart';
+import 'package:uni/model/entities/reservation.dart';
 import 'package:uni/model/entities/session.dart';
 import 'package:uni/model/entities/trip.dart';
 import 'package:uni/utils/constants.dart' as Constants;
 
 import 'entities/exam.dart';
 import 'entities/lecture.dart';
 import 'entities/restaurant.dart';
+import 'entities/library.dart';
 
 enum RequestStatus { none, busy, failed, successful }
 
@@ -19,6 +21,7 @@ class AppState {
       'schedule': <Lecture>[],
       'exams': <Exam>[],
       'restaurants': <Restaurant>[],
+      'library':LibraryOccupation,
       'filteredExam': Map<String, bool>(),
       'scheduleStatus': RequestStatus.none,
       'loginStatus': RequestStatus.none,
@@ -34,7 +37,11 @@ class AppState {
       'printBalanceStatus': RequestStatus.none,
       'feesStatus': RequestStatus.none,
       'coursesStateStatus': RequestStatus.none,
-      'lastUserInfoUpdateTime': null
+      'lastUserInfoUpdateTime': null,
+      'reservations': <Reservation>[],
+      'reservationsStatus': RequestStatus.none,
+      'occupation': LibraryOccupation(),
+      'occupationStatus': RequestStatus.none
     };
   }
 

app_feup/lib/model/entities/library.dart

@@ -0,0 +1,68 @@
+/// Overall occupation of the library
+class LibraryOccupation {
+  int occupation;
+  int capacity;
+  List<FloorOccupation> floors; 
+
+  LibraryOccupation() {
+    this.occupation = 0;
+    this.capacity = 0;
+    floors = []; 
+  }
+
+  void addFloor(FloorOccupation floor) {
+    floors.add(floor);
+    this.occupation += floor.getOccupation();
+    this.capacity += floor.getCapacity();
+  }
+
+  int getPercentage() {
+    if (capacity == 0) return 0;
+    return (occupation * 100 / capacity).round();
+  }
+
+  int getOccupation() {
+    return this.occupation;
+  }
+
+  int getCapacity() {
+    return this.capacity;
+  }
+
+  List<FloorOccupation> getFloors() {
+    return this.floors;
+  }
+
+  FloorOccupation getFloor(int number) {
+    if (floors.length < number || number < 0) return FloorOccupation(0, 0, 0);
+    return floors[number - 1];
+  }
+}
+
+/// Occupation values of a single floor
+class FloorOccupation {
+  int number;
+  int occupation;
+  int capacity;
+
+  FloorOccupation(this.number, this.occupation, this.capacity);
+
+  int getNumber() {return this.number;}
+  int getOccupation() {return this.occupation;}
+  int getCapacity() {return this.capacity;}
+  void setCapacity(int occupation) {this.occupation = occupation;}
+
+  int getPercentage() {
+    if (capacity == 0) return 0;
+    return (occupation * 100 / capacity).round();
+  }
+
+  Map<String, dynamic> toMap() {
+    final Map<String, dynamic> map = {
+      'number' : number,
+      'occupation' : occupation,
+      'capacity' : capacity, 
+    };
+    return map;
+  }
+}

app_feup/lib/model/entities/reservation.dart

@@ -0,0 +1,35 @@
+import 'dart:ui';
+
+/// Private room reservation from the library
+class Reservation {
+  String room;
+  DateTime startDate;
+  Duration duration;
+
+  Reservation(this.room, this.startDate, this.duration);
+
+  Map<String, dynamic> toMap() {
+    final Map<String, dynamic> map = {
+      'room' : room,
+      'startDate' : startDate.millisecondsSinceEpoch,
+      'duration' : duration.inHours, 
+    };
+    return map;
+  }
+
+  @override
+  String toString() {
+    return '$room, $startDate, $duration';
+  }
+
+  @override
+  bool operator == (Object other){
+    return other is Reservation
+      && room == other.room
+      && (startDate.compareTo(other.startDate) == 0)
+      && (duration.compareTo(other.duration) == 0);
+  }
+
+  @override
+  int get hashCode => hashValues(room, startDate, duration);
+}

app_feup/lib/model/home_page_model.dart

@@ -1,2 +1,3 @@
 enum FAVORITE_WIDGET_TYPE
-{exams, schedule, printBalance, account, busStops,libraryOccupation}
+{exams, schedule, printBalance, account, busStops,libraryOccupation
+  ,roomReservations}