From 03b1e04f776b162d04ef3ac99ea08e241ed8ed2c Mon Sep 17 00:00:00 2001
From: devrnt <devrient.jonas@gmail.com>
Date: Sat, 22 Sep 2018 17:43:28 +0200
Subject: [PATCH] Add subtitles to movie details Add subtitle model Add service
 to fetch the subtitles crawled from the DOM Known issue: #15

---
 android/app/src/main/AndroidManifest.xml |   1 +
 android/build.gradle                     |   9 ++
 assets/images/flag_placeholder.jpg       | Bin 0 -> 3051 bytes
 lib/models/subtitle.dart                 |  54 ++++++++
 lib/screens/home_screen.dart             |   4 +-
 lib/screens/movie_details_screen.dart    | 167 ++++++++++++++++++++++-
 lib/services/storage_service.dart        |   6 +-
 lib/services/subtitle_service.dart       |  95 +++++++++++++
 pubspec.lock                             |  15 +-
 pubspec.yaml                             |   5 +-
 10 files changed, 345 insertions(+), 11 deletions(-)
 create mode 100644 assets/images/flag_placeholder.jpg
 create mode 100644 lib/models/subtitle.dart
 create mode 100644 lib/services/subtitle_service.dart

diff --git a/android/app/src/main/AndroidManifest.xml b/android/app/src/main/AndroidManifest.xml
index 1d9920b..76d5118 100644
--- a/android/app/src/main/AndroidManifest.xml
+++ b/android/app/src/main/AndroidManifest.xml
@@ -6,6 +6,7 @@
          to allow setting breakpoints, to provide hot reload, etc.
     -->
     <uses-permission android:name="android.permission.INTERNET"/>
+    <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
     
     <!-- io.flutter.app.FlutterApplication is an android.app.Application that
          calls FlutterMain.startInitialization(this); in its onCreate method.
diff --git a/android/build.gradle b/android/build.gradle
index abea04c..1c18dbe 100644
--- a/android/build.gradle
+++ b/android/build.gradle
@@ -23,6 +23,15 @@ subprojects {
 }
 subprojects {
     project.evaluationDependsOn(':app')
+    // this is fix for the compile and runtime version error
+    project.configurations.all {
+        resolutionStrategy.eachDependency { details ->
+            if (details.requested.group == 'com.android.support'
+                    && !details.requested.name.contains('multidex') ) {
+                details.useVersion "26.0.1"
+            }
+        }
+    }
 }
 
 task clean(type: Delete) {
diff --git a/assets/images/flag_placeholder.jpg b/assets/images/flag_placeholder.jpg
new file mode 100644
index 0000000000000000000000000000000000000000..1f9189fd9342e87063806d742e4142b2899669d7
GIT binary patch
literal 3051
zcmex=<Nrg>fQ*uo0xNy}ykfn?l>DSrz2y8{{ffi_eM3D1eFhu*ih{)C?9>v4q}24x
zJX@vryZ0+8WTx0Eg`4^s_!c;)W@LI)6{QAO`Gq7`WhYyvDB0U7*i=|m<QC+nmLw`v
z<mTiRTUFR9fep6;vO&W7N(x{lCE2!0jv!kVB76fBob!uP6-@QabdwEDj1<f*^$g7n
zER9Tb6pRcE&Gik;^$m@64GgUe%&d$p6`()~Xj@TAnpKdC8`Lf!&sGWQsq*r2y>er{
z{GxPyLrY6beFGzXBO_g)3f<z$ypqHU-MnIDm<cYa#mPmP1tppJc?uvC6O-~wOKg>t
z^no_$L#+TY;eNA&xnYzZ4S~@R7!85Z5Eu=C(GVCxA%JKdrRD*fMCHJ?&;Pd!IsqB^
zCHch}`2`BbdIk&@PM*Fjsth0?a7DJ~W<SFwmX{5jGv54gs{4PNp@o5wc))}J%y0nJ
z&cw(Flm%kA1hI_&cNth1IR3w5-~+eC7*Y-Z-OBj?0D~Y0g9d{QGlL)lqaY)bAmjfd
z45<u^42-OdAm6|M7c&bh8#@OhiXcc*fC1znpetCRN|~4$Sr}La*@P6?g$+fN5{*n9
zOScGO==*<*frlCB0zoE02789qeawsv2NDb<c=-Qc0CJeVM@N>MnP{2xh-STwI%9go
zn=!xYO3DuXZ9Xo`lIP1jC@HCmu6p(M#>x$Aw)E~kv1qr_$?T~?msfM%G-XfnoHVaO
z&`znozk@gGKZ9#2-@3W4zrXCw+M*heqrT+t%hJ|s{L4k9IVaw`F>_{Phy3{--e92h
z|1Sb<X4YK%_jTakW&8hT9eC&YmECno;w#<O%SC3^ske&)Sh}7?N4E<a`LdaJSUht`
z|9Ixdf#uh0122F774<YK+UweyyR+&J1q9_h49~uivcsZjJ=0SE*NyXPY93U62U&3m
z<hlP0Ay30@W#{bKEgbjP+~PsXl91KhW+EJ)TyHTOAE}(fHG8+_&Yib!udDs~Hs}3K
k#}gAgmwuadRi^QXz;{NMkA}h$5@*<$85{p!Mh>@|0KF_Sv;Y7A

literal 0
HcmV?d00001

diff --git a/lib/models/subtitle.dart b/lib/models/subtitle.dart
new file mode 100644
index 0000000..4f32dad
--- /dev/null
+++ b/lib/models/subtitle.dart
@@ -0,0 +1,54 @@
+class Subtitle {
+  String language;
+  // String name;
+  String imageUrl;
+  String downloadUrl;
+  String countryCode;
+  int rating;
+  static final String baseUrl = 'https://www.yifysubtitles.com';
+
+  // Fill this map up for every country name that is not 
+  // directly convertable for a flag code on the site
+  // https://countryflags.io/
+
+  final Map<String, String> countryCodes = {
+    'english': 'GB',
+    'dutch': 'NL',
+    'danish': 'DK',
+    'portuguese': 'PT',
+    'spanish': 'ES',
+    'turkish': 'TR',
+    'polish': 'PL',
+    'hebrew': 'IL',
+    'bulgarian': 'BG',
+    'arabic': 'SA',
+    'croatian': 'HR',
+    'chinese': 'CN',
+    'serbian': 'RS',
+    'bengali': 'BD',
+    'swedish': 'SE',
+    'korean': 'KR',
+    'malay': 'MY',
+    'farsi/persian': 'IR'
+  };
+
+  Subtitle({this.language, String downloadUrl, this.rating}) {
+    // default href is not the download link
+    // this might change on the subtitle website
+    String formattedDownloadUrl =
+        downloadUrl.replaceFirst('/subtitles', '/subtitle');
+
+    this.downloadUrl = '$baseUrl$formattedDownloadUrl.zip';
+    this.countryCode = _getCountryCode(language);
+  }
+
+  String _getCountryCode(String language) {
+    if (countryCodes.containsKey(language.toLowerCase())) {
+      return countryCodes[language.toLowerCase()];
+    } else {
+      // suppose country code is first to chars of language
+      // this works most of the time
+      return language.substring(0, 2);
+    }
+  }
+}
diff --git a/lib/screens/home_screen.dart b/lib/screens/home_screen.dart
index ee1f68d..9acfd53 100644
--- a/lib/screens/home_screen.dart
+++ b/lib/screens/home_screen.dart
@@ -221,7 +221,7 @@ class _HomeScreenState extends State<HomeScreen>
   }
 
   TabBarView _buildTabBarView() {
-    _fetchLatestMovies();
+    // _fetchLatestMovies();
     return TabBarView(
       controller: _tabController,
       children: <Widget>[
@@ -279,7 +279,7 @@ class _HomeScreenState extends State<HomeScreen>
                   )
                 : Center(child: CircularProgressIndicator());
           },
-        )
+        ),
       ],
     );
   }
diff --git a/lib/screens/movie_details_screen.dart b/lib/screens/movie_details_screen.dart
index 1a58b43..40a8e23 100644
--- a/lib/screens/movie_details_screen.dart
+++ b/lib/screens/movie_details_screen.dart
@@ -1,15 +1,20 @@
 import 'dart:async';
 
 import 'package:flutter/material.dart';
+import 'package:movie_catalog/models/subtitle.dart';
 import 'package:movie_catalog/services/storage_service.dart';
+import 'package:movie_catalog/services/subtitle_service.dart';
 
 import 'package:url_launcher/url_launcher.dart';
 
 import 'package:movie_catalog/models/movie.dart';
 import 'package:movie_catalog/models/torrent.dart';
 
+import 'package:simple_permissions/simple_permissions.dart';
+
 class MovieDetails extends StatefulWidget {
   final GlobalKey<ScaffoldState> _scaffoldKey = new GlobalKey<ScaffoldState>();
+
   final Movie movie;
 
   MovieDetails({this.movie});
@@ -38,7 +43,7 @@ class MovieDetails extends StatefulWidget {
               child: FadeInImage.assetNetwork(
                 fadeInDuration: Duration(milliseconds: 100),
                 fadeInCurve: Curves.linear,
-                image: movie.coverImageLarge??movie.coverImageMedium,
+                image: movie.coverImageLarge ?? movie.coverImageMedium,
                 placeholder: 'assets/images/cover_placeholder.jpg',
                 fit: BoxFit.cover,
                 height: 170.0,
@@ -109,7 +114,7 @@ class MovieDetails extends StatefulWidget {
       });
       formattedGenres = genres.substring(0, genres.length - 2);
     } else {
-      formattedGenres = '';
+      formattedGenres = 'No genres';
     }
 
     // remove the last comma
@@ -334,7 +339,17 @@ class MovieDetails extends StatefulWidget {
 
 class MovieDetailsState extends State<MovieDetails> {
   StorageService _storageService;
+  SubtitleService _subtitleService;
+  Subtitle _selectedSubtitle;
+  Future<List<Subtitle>> _subtitles;
+
+  // permissions
+  String _platformVersion = 'Unknown';
+  Permission permission = Permission.WriteExternalStorage;
+
   bool liked = false;
+
+  bool _subtitlesAvailable = true;
   @override
   Widget build(BuildContext context) {
     return Scaffold(
@@ -343,6 +358,7 @@ class MovieDetailsState extends State<MovieDetails> {
         title: Text(widget.movie.title, style: TextStyle(fontSize: 17.0)),
         actions: <Widget>[
           IconButton(
+            tooltip: 'Add movie to your library',
             iconSize: 20.0,
             icon: Icon(
               liked ? Icons.favorite : Icons.favorite_border,
@@ -397,13 +413,14 @@ class MovieDetailsState extends State<MovieDetails> {
           ),
           widget._buildSummary(),
           widget._buildGenres(),
+          _buildSubtitles(),
           Container(
             margin: EdgeInsets.all(15.0),
             child: Row(
               children: widget._buildTorrents(widget.movie.torrents,
                   Theme.of(context).accentColor, context),
             ),
-          )
+          ),
         ],
       ),
     );
@@ -413,11 +430,14 @@ class MovieDetailsState extends State<MovieDetails> {
   void initState() {
     super.initState();
     _storageService = new StorageService();
+    _subtitleService = new SubtitleService();
+    _subtitles = _subtitleService.getSubtitles(widget.movie.imdbCode);
     _storageService.liked(widget.movie).then((result) {
       setState(() {
         liked = result;
       });
     });
+    initPlatformState();
   }
 
   void _showSnackBar({String title, Color color, IconData icon}) {
@@ -443,4 +463,145 @@ class MovieDetailsState extends State<MovieDetails> {
     );
     widget._scaffoldKey.currentState.showSnackBar(snackbar);
   }
+
+  Widget _buildSubtitles() {
+    final String subtitleString = 'subtitles:'.toUpperCase();
+    return Container(
+      margin: EdgeInsets.all(15.0),
+      child: Row(
+        children: <Widget>[
+          Text(
+            subtitleString,
+            style: TextStyle(color: Colors.grey, fontWeight: FontWeight.bold),
+          ),
+          Padding(
+            padding: EdgeInsets.only(left: 10.0),
+          ),
+          FutureBuilder(
+              future: _subtitles,
+              builder: (context, snapshot) {
+                if (snapshot.hasError) print(snapshot.error);
+                if (snapshot.hasData) {
+                  if (snapshot.data.isEmpty) {
+                    return Text('No subtitles available');
+                  } else {
+                    return _buildSubtitleDropDown(snapshot.data);
+                  }
+                } else {
+                  return Center(
+                    child: SizedBox(
+                      height: 12.0,
+                      width: 12.0,
+                      child: CircularProgressIndicator(
+                        strokeWidth: 2.0,
+                      ),
+                    ),
+                  );
+                }
+              }),
+        ],
+      ),
+    );
+  }
+
+  Widget _buildSubtitleDropDown(List<Subtitle> subtitles) {
+    return Row(
+      children: <Widget>[
+        DropdownButton(
+          style: TextStyle(fontSize: 16.0),
+          value: _selectedSubtitle,
+          hint: Text('Language'),
+          isDense: true,
+          onChanged: (Subtitle subtitle) {
+            print(subtitle.language);
+            setState(() {
+              _selectedSubtitle = subtitle;
+            });
+          },
+          items: subtitles
+              .map(
+                (sub) => DropdownMenuItem(
+                      value: sub,
+                      child: Row(
+                        children: <Widget>[
+                          FadeInImage.assetNetwork(
+                            image:
+                                'https://www.countryflags.io/${sub.countryCode}/flat/32.png',
+                            height: 22.0,
+                            placeholder: 'assets/images/flag_placeholder.jpg',
+                          ),
+                          Padding(
+                            padding: EdgeInsets.only(left: 12.0),
+                          ),
+                          Text(sub.language),
+                        ],
+                      ),
+                    ),
+              )
+              .toList(),
+        ),
+        _selectedSubtitle != null
+            ? Container(
+                alignment: Alignment.center,
+                child: IconButton(
+                  icon: Icon(
+                    Icons.save_alt,
+                    color: Theme.of(context).accentColor,
+                  ),
+                  onPressed: () {
+                    _downloadFile(_selectedSubtitle.downloadUrl);
+                  },
+                ),
+              )
+            : Container(),
+      ],
+    );
+  }
+
+  void _downloadFile(String url) async {
+    if (await checkPermission()) {
+      await _subtitleService.downloadSubtitle(url);
+      _showSnackBar(
+          color: Theme.of(context).accentColor,
+          icon: Icons.done,
+          title: 'Subtitle downloaded in your Downloads folder');
+    } else {
+      await requestPermission();
+      if (await checkPermission() == false) {
+        _showSnackBar(
+            color: Colors.amber[700],
+            icon: Icons.warning,
+            title: 'Please accept the permission');
+        //
+      } else {
+        _downloadFile(url);
+      }
+    }
+  }
+
+  // permissions
+  void initPlatformState() async {
+    String platformVersion;
+    try {
+      platformVersion = await SimplePermissions.platformVersion;
+    } on Exception {
+      platformVersion = 'Failed to get platform version';
+    }
+
+    // If the widget was removed from the tree while the asynchronous platform
+    // message was in flight, we want to discard the reply rather than calling
+    // setState to update our non-existent appearance.
+    if (!mounted) return;
+
+    _platformVersion = platformVersion;
+  }
+
+  requestPermission() async {
+    final res = await SimplePermissions.requestPermission(permission);
+  }
+
+  Future<bool> checkPermission() async {
+    bool res = await SimplePermissions.checkPermission(permission);
+    return res;
+  }
 }
diff --git a/lib/services/storage_service.dart b/lib/services/storage_service.dart
index 59b347f..939f8e1 100644
--- a/lib/services/storage_service.dart
+++ b/lib/services/storage_service.dart
@@ -13,7 +13,6 @@ class StorageService {
 
   Future<String> get _localPath async {
     final directory = await getApplicationDocumentsDirectory();
-
     return directory.path;
   }
 
@@ -55,4 +54,9 @@ class StorageService {
         movies.any((movieFromStorage) => movieFromStorage.id == movie.id);
     return flag;
   }
+
+  Future<String> get downloadsPath async {
+    final directoryTemp = await getExternalStorageDirectory();
+    return '${directoryTemp.path}/Download';
+  }
 }
diff --git a/lib/services/subtitle_service.dart b/lib/services/subtitle_service.dart
new file mode 100644
index 0000000..362fa09
--- /dev/null
+++ b/lib/services/subtitle_service.dart
@@ -0,0 +1,95 @@
+import 'dart:async';
+import 'dart:io';
+
+import 'package:archive/archive.dart';
+import 'package:html/dom.dart';
+import 'package:http/http.dart' as http;
+
+import 'package:html/parser.dart';
+import 'package:movie_catalog/models/subtitle.dart';
+import 'package:movie_catalog/services/storage_service.dart';
+
+// WEB CRAWLER - DOM MIGHT CHANGE IN FUTURE
+class SubtitleService {
+  http.Client _client;
+  StorageService _storageService;
+  String _baseUrl = 'https://www.yifysubtitles.com/movie-imdb';
+  String _url;
+  // static var httpClient = new HttpClient(); is for original download code
+
+  SubtitleService() {
+    _client = new http.Client();
+    _storageService = new StorageService();
+  }
+
+  Future<Document> _fetchDOM(String imdbCode) async {
+    _url = '$_baseUrl/$imdbCode';
+    final response = await _client.get(_url);
+    final document = parse(response.body);
+    return document;
+  }
+
+  Future<List<Subtitle>> getSubtitles(String imdbCode) async {
+    bool subtitlesAvailable = false;
+
+    Document document = await _fetchDOM(imdbCode);
+
+    subtitlesAvailable =
+        document.getElementsByTagName('tbody').isEmpty ? false : true;
+
+    List<Subtitle> subtitles = [];
+
+    if (subtitlesAvailable) {
+      List<Element> startElement = document.getElementsByClassName('sub-lang');
+
+      subtitles = startElement.map((elem) {
+        return new Subtitle(
+            // id: int.parse(elem.parent.parent.attributes['data-id']),
+            language: elem.text,
+            downloadUrl:
+                elem.parent.nextElementSibling.firstChild.attributes['href'],
+            rating:
+                int.parse(elem.parent.previousElementSibling.firstChild.text));
+      }).toList();
+    }
+    // filter the big subtitle list
+    // Why? performance and quality
+    return subtitles.where((sub) => sub.rating > 0).toList();
+  }
+
+  Future<File> downloadSubtitle(String url) async {
+    var req = await _client.get(Uri.parse(url));
+    var bytes = req.bodyBytes;
+
+    // THIS IS THE ORIGAL I wrote it with http package; (above)
+    // var request = await httpClient.getUrl(Uri.parse(url));
+    // var response = await request.close();
+    // var bytes = await consolidateHttpClientResponseBytes(response);
+
+    String path = await _storageService.downloadsPath;
+
+    String fileName = url
+        .replaceFirst('https://www.yifysubtitles.com/subtitle/', '')
+        .replaceFirst('.zip', '')
+        .replaceFirst('-yify-', '');
+
+    File file = new File('$path/$fileName');
+    file.writeAsBytesSync(bytes);
+
+    Archive archive = new ZipDecoder().decodeBytes(file.readAsBytesSync());
+
+    file.deleteSync();
+
+    // Extract the contents of the Zip archive to disk.
+    for (ArchiveFile file in archive) {
+      String filename = file.name;
+      if (file.isFile) {
+        List<int> data = file.content;
+        return new File('$path/$filename')
+          ..createSync(recursive: true)
+          ..writeAsBytesSync(data);
+      }
+    }
+    return null;
+  }
+}
diff --git a/pubspec.lock b/pubspec.lock
index 9bad195..94bdd81 100644
--- a/pubspec.lock
+++ b/pubspec.lock
@@ -9,7 +9,7 @@ packages:
     source: hosted
     version: "0.32.4"
   archive:
-    dependency: transitive
+    dependency: "direct main"
     description:
       name: archive
       url: "https://pub.dartlang.org"
@@ -271,7 +271,7 @@ packages:
       name: petitparser
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.7.7"
+    version: "2.0.1"
   platform:
     dependency: transitive
     description:
@@ -335,6 +335,13 @@ packages:
       url: "https://pub.dartlang.org"
     source: hosted
     version: "0.2.2+4"
+  simple_permissions:
+    dependency: "direct main"
+    description:
+      name: simple_permissions
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "0.1.7"
   sky_engine:
     dependency: transitive
     description: flutter
@@ -451,7 +458,7 @@ packages:
       name: xml
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "3.0.1"
+    version: "3.2.1"
   yaml:
     dependency: transitive
     description:
@@ -460,5 +467,5 @@ packages:
     source: hosted
     version: "2.1.15"
 sdks:
-  dart: ">=2.0.0-dev.68.0 <=2.1.0-dev.3.1.flutter-760a9690c2"
+  dart: ">=2.0.0 <=2.1.0-dev.3.1.flutter-760a9690c2"
   flutter: ">=0.1.4 <2.0.0"
diff --git a/pubspec.yaml b/pubspec.yaml
index 37462b8..15038dc 100644
--- a/pubspec.yaml
+++ b/pubspec.yaml
@@ -9,7 +9,9 @@ dependencies:
   url_launcher: ^3.0.3
   path_provider: ^0.4.1
   firebase_messaging: ^2.0.0
-
+  simple_permissions: ^0.1.7
+  archive: ^2.0.4
+  
   # The following adds the Cupertino Icons font to your application.
   # Use with the CupertinoIcons class for iOS style icons.
   cupertino_icons: ^0.1.2
@@ -46,6 +48,7 @@ flutter:
   #  - images/a_dot_ham.jpeg
   assets:
     - assets/images/cover_placeholder.jpg
+    - assets/images/flag_placeholder.jpg
     - assets/icon/icon.png
 
   # An image asset can refer to one or more resolution-specific "variants", see