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 v17
Kodi.tv repo v16
Kodi.tv repo v15

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. Settings
  2. Add-ons
  3. Install from repository (v15/v16) / Get add-ons (v14)
  4. Kodi add-on repository
  5. Program Add-ons
  6. WatchedList
  7. Install

2 Setup

2.1 Basic Settings

  1. Debug mode: Show more notifications, create more entries in kodi.log
  2. Update watched state of movies
  3. Update watched state of episodes
  4. Autorun: starts with XBMC after a delay time of x minutes.
  5. Startup delay (see above x). Set the delay time to not disturb directly at startup.
  6. 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.
  7. Update interval (active if set to 'periodic' above)
  8. Follow user ...: Run in background and update the watchedlist database every time the user changes a watched state
  9. Progress dialog: Show a progress bar for every full update. No user interaction possible in this time.

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. I recommend a mysql database, since there were problems with the SQLite database file consistency since XBMC v13. 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 xbmc or edit this value manually in the "%appdata%\XBMC\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. 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. On the contrary the directory will be filled with new files on every change to the WL-DB (no file Rotation, drive space).
  6. MySQL: IP-adress of the Server. Make sure, there is a mysql server running. To start, use [MySQL/Setting_up_MySQL this] guide.
  7. MySQL: 3306 is the default mysql port. No need to change it.
  8. MySQL: Name of the database. You manually need to create this database on the mysql server (use phpMyAdmin)
  9. MySQL: Username. This user must exist and have all necessary permissions on the database set before
  10. 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

The SQLite Database file option is no longer recommended. To transfer an existing SQLite WatchedList? Database, read below.

The script creates a SQLite database. To view the database I used SQLite Database Browser.

https://sourceforge.net/projects/sqlitebrowser/files/latest/download

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

File overview

The database 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 XBMC, 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)\)\)"
  • 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 XBMC Database is queried and updated with JSON-RPC. It should not matter whether you use xbmc mysql or xbmc 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 xbmc library (probably not executable from within xbmc)
  • 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