bug:Unflexible TUFilm Parser

README.md

@@ -86,6 +86,7 @@ The following environment variables need to be set for the server to work proper
 * [REQUIRED] `DB_ROOT_PASSWORD`: The password of the root user.
 * [OPTIONAL] `DB_PORT`: The port of the database server. Defaults to `3306`.
 * [OPTIONAL] `SENTRY_DSN`: The Sentry [Data Source Name](https://sentry-docs-git-patch-1.sentry.dev/product/sentry-basics/dsn-explainer/) for reporting issues and crashes.
+* [OPTIONAL] `OMDB_API_KEY`: The key to get more information for tu-film movies from [omdbapi](https://omdbapi.com/). See [omdbapi](https://omdbapi.com/apikey.aspx) for a key.
 * **[iOS Push Notification Service [OPTIONAL]](#ios-push-notifications-service)**:
   * [REQUIRED] `APNS_KEY_ID`: The key ID of the APNs key => APNs Key needs to be downloaded from the Apple Developer Portal the name of the file also contains the key ID.
   * [REQUIRED] `APNS_TEAM_ID`: The team ID of the iOS app can be found in AppStoreConnect.

server/api/tumdev/campus_backend.proto

@@ -487,25 +487,38 @@ message ListMoviesReply {
 }
 
 message Movie {
-  reserved /*string cover_name = */ 1;
-  reserved /*string cover_path =*/ 2;
+  // the id of the movie
   int64 movie_id = 3;
+  // the date of the movie
   google.protobuf.Timestamp date = 4;
+  // when the movie was created in OUR database
   google.protobuf.Timestamp created = 5;
+  // title of the movie if available, empty otherwise
   string title = 6;
-  // release year of the movie
+  // Where the movie is shown
+  string location = 18;
+  // release year of the movie if available, empty otherwise
   string release_year = 7;
+  // runtime of the movie if available, empty otherwise
   string runtime = 8;
+  // genre of the movie if available, empty otherwise
   string genre = 9;
+  // director of the movie as by omdb(/tu-film), empty otherwise
   string director = 10;
+  // actors of the movie as by omdb(/tu-film), empty otherwise
   string actors = 11;
-  // imdb rating
+  // imdb rating for the movie if available, empty otherwise
   string imdb_rating = 12;
+  // short description of the movie including limited html tags (only <b>, <i>)
   string description = 13;
-  int64 cover_id = 14;
-  reserved /*string trailer*/ 15;
+  // Where to find a trailer for this movie
+  string trailer_url = 15;
   // Where to find additional information about this movie
-  string link = 16;
+  string additional_information_url = 16;
+
+  reserved /*cover_name,cover_path = */ 1, 2;
+  // the id of the cover image
+  int64 cover_id = 14;
   // Where to find a cover image for this movie
   string cover_url = 17;
 }

server/api/tumdev/campus_backend.swagger.json

@@ -1483,50 +1483,68 @@
       "properties": {
         "movieId": {
           "type": "string",
-          "format": "int64"
+          "format": "int64",
+          "title": "the id of the movie"
         },
         "date": {
           "type": "string",
-          "format": "date-time"
+          "format": "date-time",
+          "title": "the date of the movie"
         },
         "created": {
           "type": "string",
-          "format": "date-time"
+          "format": "date-time",
+          "title": "when the movie was created in OUR database"
         },
         "title": {
-          "type": "string"
+          "type": "string",
+          "title": "title of the movie if available, empty otherwise"
+        },
+        "location": {
+          "type": "string",
+          "title": "Where the movie is shown"
         },
         "releaseYear": {
           "type": "string",
-          "title": "release year of the movie"
+          "title": "release year of the movie if available, empty otherwise"
         },
         "runtime": {
-          "type": "string"
+          "type": "string",
+          "title": "runtime of the movie if available, empty otherwise"
         },
         "genre": {
-          "type": "string"
+          "type": "string",
+          "title": "genre of the movie if available, empty otherwise"
         },
         "director": {
-          "type": "string"
+          "type": "string",
+          "title": "director of the movie as by omdb(/tu-film), empty otherwise"
         },
         "actors": {
-          "type": "string"
+          "type": "string",
+          "title": "actors of the movie as by omdb(/tu-film), empty otherwise"
         },
         "imdbRating": {
           "type": "string",
-          "title": "imdb rating"
+          "title": "imdb rating for the movie if available, empty otherwise"
         },
         "description": {
-          "type": "string"
+          "type": "string",
+          "title": "short description of the movie including limited html tags (only \u003cb\u003e, \u003ci\u003e)"
         },
-        "coverId": {
+        "trailerUrl": {
           "type": "string",
-          "format": "int64"
+          "title": "Where to find a trailer for this movie"
         },
-        "link": {
+        "additionalInformationUrl": {
           "type": "string",
           "title": "Where to find additional information about this movie"
         },
+        "coverId": {
+          "type": "string",
+          "format": "int64",
+          "title": "the id of the cover image"
+        },
         "coverUrl": {
           "type": "string",
           "title": "Where to find a cover image for this movie"

server/backend/cron/movie_parsers/omdb.go

@@ -0,0 +1,60 @@
+package movie_parsers
+
+import (
+	"encoding/json"
+	"errors"
+	"fmt"
+	"io"
+	"net/http"
+	"os"
+
+	log "github.com/sirupsen/logrus"
+)
+
+type OmdbResults struct {
+	ReleaseYear string `json:"Year"`
+	Runtime     string
+	Genre       string
+	Director    string
+	Actors      string
+	Plot        string
+	ImdbRating  string `json:"imdbRating"`
+}
+
+func GetOmdbMovie(id string) (*OmdbResults, error) {
+	url := fmt.Sprintf("https://www.omdbapi.com/?r=json&v=1&i=%s&apikey=%s", id, os.Getenv("OMDB_API_KEY"))
+	resp, err := http.Get(url)
+	if err != nil {
+		log.WithField("url", url).WithError(err).Error("Error while getting response for request")
+		return nil, err
+	}
+	// check if the api key is valid
+	if resp.StatusCode == http.StatusUnauthorized {
+		return nil, errors.New("missing or invalid api key for omdb (environment variable OMDB_API_KEY)")
+	}
+	// other errors
+	if resp.StatusCode != http.StatusOK {
+		body, err := io.ReadAll(resp.Body)
+		if err != nil {
+			log.WithError(err).Warn("Unable to read http body")
+			return nil, err
+		} else {
+			log.WithField("status", resp.StatusCode).WithField("status", resp.Status).WithField("body", string(body)).Error("error while getting omdb movie")
+			return nil, errors.New("error while getting omdb movie")
+		}
+	}
+	defer func(Body io.ReadCloser) {
+		err := Body.Close()
+		if err != nil {
+			log.WithField("url", url).WithError(err).Error("Error while closing body")
+		}
+	}(resp.Body)
+	// parse the response body
+	var res OmdbResults
+	err = json.NewDecoder(resp.Body).Decode(&res)
+	if err != nil {
+		log.WithField("url", url).WithError(err).Error("Error while unmarshalling omdbResults")
+		return nil, err
+	}
+	return &res, nil
+}