falocalrepo-database 4.8.0

Database functionality for falocalrepo.

FALocalRepo-Database

Database functionality for falocalrepo.

Usage

Detailed usage and components documentation will be added in a future patch

Tables

To store its information, the database uses four tables: SETTINGS, USERS, SUBMISSIONS and JOURNALS.

Note: bar-separated lists are formatted as |item1||item2| to properly isolate all elements

Settings

The settings table contains settings for the program and statistics of the database.

• HISTORY list of executed commands in the format [[<time1>, "<command1>"], ..., [<timeN>, "<commandN>"]] (UNIX time in seconds)
• COOKIES cookies for the scraper, stored in JSON format
• FILESFOLDER location of downloaded submission files
• VERSION database version

Users

The users table contains a list of all the users that have been download with the program, the folders that have been downloaded, and the submissions found in each of those.

Each entry contains the following fields:

• USERNAME The URL username of the user (no underscores or spaces)
• FOLDERS the folders downloaded for that specific user, sorted and bar-separated

Submissions

The submissions table contains the metadata of the submissions downloaded by the program and information on their files

• ID the id of the submission
• AUTHOR the username of the author (uploader) in full format
• TITLE
• DATE upload date in the format YYYY-MM-DD
• DESCRIPTION description in html format
• TAGS keywords sorted alphanumerically and bar-separated
• CATEGORY
• SPECIES
• GENDER
• RATING
• FILEURL the remote URL of the submission file
• FILEEXT the extensions of the downloaded file. Can be empty if the file contained errors and could not be recognised upon download
• FILESAVED 1 if the file was successfully downloaded and saved, 0 if there was an error during download
• FAVORITE a bar-separated list of users that have "faved" the submission
• MENTIONS a bar-separated list of users that are mentioned in the submission description as links
• FOLDER the folder of the submission (gallery or scraps)
• USERUPDATE whether the submission was added as a user update or favorite/single entry

Journals

The journals table contains the metadata of the journals downloaded by the program.

• ID the id of the journal
• AUTHOR the username of the author (uploader) in full format
• TITLE
• DATE upload date in the format YYYY-MM-DD
• CONTENT content in html format
• MENTIONS a bar-separated list of users that are mentioned in the journal content as links
• USERUPDATE whether the journal was added as a user update or favorite/single entry

Submission Files

The save_submission functions saves the submission metadata in the database and stores the files.

Submission files are saved in a tiered tree structure based on their submission ID. ID's are zero-padded to 10 digits and then broken up in 5 segments of 2 digits; each of this segments represents a folder tha will be created in the tree.

For example, a submission 1457893 will be padded to 0001457893 and divided into 00, 01, 45, 78, 93. The submission file will then be saved as 00/01/45/78/93/submission.file with the correct extension extracted from the file itself - FurAffinity links do not always contain the right extension and often confuse jpg and png.

Upgrading Database

The FADatabase.upgrade function allows to upgrade the database to the current version.

Note: Versions before 2.7.0 are not supported by falocalrepo-database version 3.0.0 and above. To update from those to the new version use falocalrepo version 2.11.2 to update the database to version 2.7.0