Add-on:WatchedList

From Official Kodi Wiki
Jump to: navigation, search

WatchedList

See this add-on on the kodi.tv showcase

Author: schapplm
Website: link
Type: Program
Repo: Kodi.tv repo v18
Kodi.tv repo v17
Kodi.tv repo v16

License: GPL v2.0
Source: Source code
Summary: Save watched Movies and TV Episodes independent from filenames
Home icon grey.png   ▶ Add-ons ▶ WatchedList
Attention talk.png Need help with this add-on? See here.

Export: Searches the Kodi-Database for watched files. Determine imdb-id and thetvdb-id to identify movies and TV-episodes. Then save the list to a new independent table.
Import: Set the watched state for each video file in Kodi.
Automatic background process without user interaction.

Contents

1 Installing

To install this add-on you must do so from the Add-on manager from within Kodi by going to

  1. The home screen
  2. Add-ons
  3. Download
  4. Program Add-ons
  5. WatchedList
  6. Install

2 Setup

2.1 Basic Settings

  1. Update watched state of movies
  2. Update watched state of episodes
  3. Autorun: starts with Kodi after a delay time of x minutes.
  4. Startup delay (see above x). Set the delay time to not disturb directly at startup.
  5. Autostart mode: 'one update' only does one full update of the watchedlist and then quits. 'periodic' executes this update in the interval given below. 'no update' does no full update. You have the possibility to run WatchedList in background.
  6. Update interval (active if set to 'periodic' above)
  7. Follow user ...: Run in background and update the WatchedList database every time the user changes a watched state (from unwatched to watched and vice versa). Marking something as "unwatched" is only possible with this setting.
  8. Progress dialog: Show a progress bar for every full update. No user interaction possible during the update (can take a few minutes, depending on verbosity and amount of changes and size of database), but it is possible to abort the whole process.
  9. Amount of User Information ("verbosity"): Determines, for which events a notification will be shown. This is independent from debug logging. Options: all (notification for updates of every single movie and episode), only info (default, only notification for major steps of the update process, only warning, only error, none (show no notifications at all)

Basic Settings

2.2 Database Settings

  1. DB Method: Either use a SQLite db file or a mysql server for the database of this addon. The default setting is a local SQLite db file. This is suitable for backup of the local watched states in case of file movements or Kodi database cleaning.
  2. DB File: Use a non-default database file (not in [...]/userdata/addon_data/service.watchedlist)
  3. DB File: Path to the database-file. To add a network path for access from multiple clients you can browse the path in Kodi or edit this value manually in the "%appdata%\Kodi\userdata\addon_data\service.watchedlist\settings.xml".
  4. DB File: Filename of the database (SQLite .db file)
  5. DB File: Create a zip backup copy (ca. 40 KB) of the database (ca 100 KB) each time before writing it. Set the number of backup files with this option. With this you can restore any state you want, e.g. when you mess with your kodi-database and too much media is marked as watched. You can set this to infinite number of backups (option -1) to make sure, but this will fill your disk over the years.
  6. Dropbox synchronization: Saves your WatchedList database in your dropbox (should take max. 1MB space). If you enable this option, the Dropbox authorization process will be started. If this option is activated with the same Dropbox account on several clients, it is possible to share the WatchedList database via the Dropbox.
  7. Dropbox Auth Code: This will has to be inserted after the Dropbox authorization process (see above).
  8. MySQL: IP-adress of the Server. Make sure, there is a mysql server running. To start, use [MySQL/Setting_up_MySQL this] guide.
  9. MySQL: 3306 is the default mysql port. No need to change it.
  10. MySQL: Name of the database. You manually need to create this database on the mysql server (use phpMyAdmin)
  11. MySQL: Username. This user must exist and have all necessary permissions on the database set before
  12. MySQL: password for this user.


Basic Settings

2.3 Useage

This addon runs in the background as a service. There is no interaction with the user. The script only gives messages about the current operation

  • After Startup, the databases are searched for watched-information (Notification 1).
  • Then newly watched movies and tv episodes are written to the addon database (Notification 2).
  • After that, media that is not watched in the Kodi database and was previously marked as watched by the addon is again marked as watched in Kodi ( Notifications 3 and 4).

2.4 Database

2.4.1 MySQL Database

The mySQL database stores all relevant information. It looks like this:

phpmyAdmin View of WatchedList database

For the description of the tables read below.

2.4.2 SQLite Database file

This Kodi Addon creates a SQLite database file called watchedlist.db by default. I recommend using the mySQL database instead, but both methods work well (see addon settings above).

To view the database you can use the Windows Tool SQLite Database Browser or the Linux Tool sqliteman. The file is by default located in %APPDATA%\Kodi\userdata\addon_data\service.watchedlist\watchedlist.db in Windows or ~/.kodi/userdata/addon_data/service.watchedlist/watchedlist.db in Linux.

This first figure shows the SQLite db file with automatically created backup copies.

File overview

The database (here opened with SQLite DB Browser) has three tables.

Database overview

The first table stores the watched movies by imdb-number. The title column is only for easier user access to the table.

Movie table overview

The second table stores watched tv episodes with unique number for the TV Show (this field is called imdbnumber in Kodi, but this is the TheTVDB number). The names of the tv shows are stored in a third table, only for better readability.

Episode table overview

2.4.3 Conversion from SQLite database to mysql database

In Version 1.0.0 of this addon, the possibility to use a mysql database was added. This has a few advantages over the SQLite Database file:

  • simultaneous access possible
  • mysql handles all the database access, therefore no permanent backup copying necessary
  • no filesystem access in the addon. Should lead to fewer errors

How to convert the database from SQLite db file to mysql:

  • open the old database file in SQLite database browser
  • File -> Export -> Database to sql file
  • bring this into the new format. For Replacement, I used Notepad++ in Windows:
  • Replace regular expression "INSERT INTO `movie_watched` VALUES \((\d+),(\d+),(\d+),(\d+)," with "INSERT IGNORE INTO `movie_watched` VALUES \((\1),(\2),FROM_UNIXTIME\((\3)\),FROM_UNIXTIME\((\4)\),"
  • Replace regular expression "INSERT INTO `episode_watched` VALUES \((\d+),(\d+),(\d+),(\d+),(\d+),(\d+)\)" with "INSERT IGNORE INTO `episode_watched` VALUES \((\1),(\2),(\3),(\4),FROM_UNIXTIME\((\5)\),FROM_UNIXTIME\((\6)\)\)"
  • The exact character sequence regarding white-spaces or backticks can be different between versions of the SQLite tool and might need adaptation
  • Save this new sql file
  • execute the commands in the "INSERT"-commands in the sql query interface in phpmyadmin after the tables were generated at the first start of the watchedlist addon with mysql option enabled.

3 Technical Details

The Kodi Database is queried and updated with JSON-RPC. It should not matter whether you use Kodi mysql or Kodi local database.

4 Limitations

The watched-status is only stored based on imdb/thetvdb number. Different Versions of a movie (DVD, BlueRay, Extended Edition, Directors Cut) are all considered equally watched.

5 Alternatives

  • Online List of watched movies
  • separate script to scan Kodi library (probably not executable from within Kodi)
  • other similar addons
  • Export watched flag in nfo file and Import it back again:


6 Feedback and Discussion

In case of errors or questions, please post them in the forum thread.

Personal tools
Namespaces

Variants
Actions
Navigation
Wiki help
Toolbox