WebAOM: Difference between revisions

From AniDB
Jump to navigation Jump to search
mNo edit summary
No edit summary
Line 6: Line 6:
:* file add to [[mylist]]<br>
:* file add to [[mylist]]<br>
:* custom file renaming and moving<br>
:* custom file renaming and moving<br>
:* local / private mysql database support<br>
'''Current Version hosted by AniDB:'''
'''Current Version hosted by AniDB:'''
:* WebAOM v1.08 (beta) [http://www.anidb.net/client/webaom.htm Applet] | [http://www.anidb.net/client/webaom.jar JAR] | [http://www.anidb.net/client/webaom.jnlp Webstart]
:* WebAOM v1.08 (beta) [http://www.anidb.net/client/webaom.htm Applet] | [http://www.anidb.net/client/webaom.jar JAR] | [http://www.anidb.net/client/webaom.jnlp Webstart]
'''Current Version hosted by epoximator:'''
'''Current Version hosted by epoximator:'''
:* WebAOM v1.13 (beta) [http://www.stud.ntnu.no/~jovetlea/webaom/index.htm Applet] | [http://www.stud.ntnu.no/~jovetlea/webaom/webaom.jar JAR] | [http://www.stud.ntnu.no/~jovetlea/webaom/webaom.jnlp Webstart]
:* WebAOM v1.14 (beta) [http://www.stud.ntnu.no/~jovetlea/webaom/index.htm Applet] | [http://www.stud.ntnu.no/~jovetlea/webaom/webaom.jar JAR] | [http://www.stud.ntnu.no/~jovetlea/webaom/webaom.jnlp Webstart]
 
'''Old versions:'''
:* http://www.hostunlim.com/epoximator/hist
== Introduction ==
== Introduction ==
WebAOM is a simple java applet/application that hash files and add them to your [[mylist]] at AniDB. It is made for those who don't want to or cannot install [[AOM|Anidb-O-Matic]]. The name may be inaccurate/misleading since it does not replace AOM in any way. It is based on the [http://www.anidb.net/client/udp-api.html UDP-API] and is therefore limited.
WebAOM is a simple java applet/application that hash files and add them to your [[mylist]] at AniDB. It is made for those who don't want to or cannot install [[AOM|Anidb-O-Matic]]. The name may be inaccurate/misleading since it does not replace AOM in any way. It is based on the [http://www.anidb.net/client/udp-api.html UDP-API] and is therefore limited.
Line 27: Line 29:
:* Files... : Add specific files for hashing. (Only those with extensions specified in "Wanted File Extensions" are added.)
:* Files... : Add specific files for hashing. (Only those with extensions specified in "Wanted File Extensions" are added.)
:* Folders... : Add folder(s) with all including files for hashing.
:* Folders... : Add folder(s) with all including files for hashing.
:* Toggle Hasher : Start/stop hashing operation (and moving).
:* Toggle fileIO : Start/stop hashing and moving thread.
:* Toggle Adder : Start/stop adding (communication thread).
:* Toggle netIO : Start/stop communication thread.
:* Save Log : Save the Log to disk (in HTML format).
:* Save Log : Save the Log to disk (in HTML format).
:* Save Options: Save options to "%home/.webaom".
:* Save Options: Save options to "%home/.webaom".
Line 60: Line 62:
::* Hash Dirs : Default directories to hash. Checked every time Hasher starts. Directories are separated with ";".
::* Hash Dirs : Default directories to hash. Checked every time Hasher starts. Directories are separated with ";".
::* Browser Path : Set path to internet browser manually here. For Linux users.
::* Browser Path : Set path to internet browser manually here. For Linux users.
::* My Database : For later versions.
::* My Database : JDBC url to local / private database.
::* Renaming : Combobox for selecting renaming mode.
::* Renaming : Combobox for selecting renaming mode.
::* [http://en.wikipedia.org/wiki/Hash_function Hash functions] : [http://en.wikipedia.org/wiki/Ed2k_(hash) ED2K] [http://en.wikipedia.org/wiki/CRC32 CRC32] [http://en.wikipedia.org/wiki/MD5 MD5] [http://en.wikipedia.org/wiki/SHA1 SHA1] [http://en.wikipedia.org/wiki/Tiger-Tree_Hash TTH]
::* [http://en.wikipedia.org/wiki/Hash_function Hash functions] : [http://en.wikipedia.org/wiki/Ed2k_(hash) ED2K] [http://en.wikipedia.org/wiki/CRC32 CRC32] [http://en.wikipedia.org/wiki/MD5 MD5] [http://en.wikipedia.org/wiki/SHA1 SHA1] [http://en.wikipedia.org/wiki/Tiger-Tree_Hash TTH]
:* Wanted File Extensions : Default are avi, ogm, mkv.
:* Wanted File Extensions : Default are avi, ogm, mkv, mp4.
:* Rename Options (removed in 1.09)
:* Rename Options (removed in 1.09)
::* Combobox for custom renaming. (More schemes can be added on request.)
::* Combobox for custom renaming. (More schemes can be added on request.)
Line 71: Line 73:
::* Hashes in uppercase : Uppercase hashes in filename. Only possible when own style is selected.
::* Hashes in uppercase : Uppercase hashes in filename. Only possible when own style is selected.
===Job Menu (Popup)===
===Job Menu (Popup)===
:* Pause : Pause / unpause job.
:* Show Info : Show info about a file/job. (double click)
:* Show Info : Show info about a file/job. (double click)
:* Watch Now : Watch with default media player. Windows only. (alt + double click)
:* Watch Now : Watch with default media player. Windows only. (alt + double click)
:* Explore Folder : Open parent folder with Explorer. Windows only.
:* Explore Folder : Open parent folder with Explorer. Windows only.
:* Rehash : Use this if you want rehash and include other hash types. (Must be selected in 'Other' options.)
:* Identify : Re-identify the file. Can be used on 'Unknown' files to check if they are added to anidb.
:* Add to mylist : Add job manually if you forgot to check 'Add files to mylist'.
:* Apply Rules : If the rules are changed after a job is finished, they can be applied again manually.
:* Apply Rules : If the rules are changed after a job is finished, they can be applied again manually.
:* Update Status : For updating file info. For later versions.
:* Set Finished : If you don't want to bother with a troublesome file, just set it as finished.
:* Remove (DB too) : Remove file info from list and database. For later versions.
:* Restore Name : Rename file to its original name.
:* Set Folder : Move file to a specific folder. Can also be used to find files when 'File not found'.
:* Remove from DB : Remove job from local database. Will be readded if used twice.


== Move/rename system ==
== Move/rename system ==
A new feature in 1.09 is moving and renaming of files based on rules. This is implemented to ease administration of your anime files. The system may seem confusing at first, but it is actually pretty simple. Since the system performs virtually no error checking on the input you provide, it is recommended that you understand the system fully before using it.  
A new feature from 1.09 is moving and renaming of files based on rules. This is implemented to ease administration of your anime files. The system may seem confusing at first, but it is actually pretty simple. Since the system performs virtually no error checking on the input you provide, it is recommended that you understand the system fully before using it.  


Notice that the system is under development. Expect radical changes. Feel free to request changes / comment.
Notice that the system is under development. Expect radical changes. Feel free to request changes / comment.
Line 94: Line 102:
  #this would create the schema "%eng (%ann) - %enr - %epn (SUB)[%grp](%CRC)" for a normal subbed file.
  #this would create the schema "%eng (%ann) - %enr - %epn (SUB)[%grp](%CRC)" for a normal subbed file.


Note that end-of-line comments "//" are not supported atm, but "#" at beginning is. >'< around parts is not required. Example on move schema:
>'< around parts is not required. Example on move schema:


  IF R(DVD,HKDVD) DO ADD 'M:\dvd\'
  IF R(DVD,HKDVD) DO ADD 'M:\dvd\'
Line 104: Line 112:


Syntax for each line in a script:
Syntax for each line in a script:
:* [IF {test}/ELSE] DO ADD {part}/SET {part}/FAIL/FINISH
:* [[ELSE] IF {test}/ELSE] DO ADD {part}/SET {part}/FAIL/FINISH [{last part}]/RETURN {complete schema}
::* ADD means +=
::* ADD means +=
::* SET means =
::* SET means =
::* FAIL means return null;
::* FAIL means return null;
::* FINISH means return result; (Not needed as last line.)
::* FINISH means return result; Also possible to add last part. (Not needed as last line.)
::* RETURN means return complete schema (for exceptions).
::* DO is always required.
::* DO is always required.
::* !!! CASE SENSITIVE !!!
::* !!! CASE SENSITIVE !!!


<b>Possible tests</b><br>
<b>Possible tests</b><br>
:* A = Anime (text/number) [*/#] Anime Name/Title (Jap. Romaji) or aid. (E = English Title will probably be added in next version.)
:* A = Anime (text/number) [*/#] Anime Name/Title (Romaji/Kanji/English) or aid.
:* G = Group (text/number) [unknown, */#] Short name or gid.
:* G = Group (text/number) [unknown, */#] Short name or gid.
:* Q = Quality (text) [unknown, very high, high, med, low, very low, corrupted, eyecancer]
:* Q = Quality (text) [unknown, very high, high, med, low, very low, corrupted, eyecancer]
Line 119: Line 128:
:* T = Type (text) [unknown, TV, OVA, Movie, Other, web]
:* T = Type (text) [unknown, TV, OVA, Movie, Other, web]
:* Y = Year (number) [#]
:* Y = Year (number) [#]
:* D = Dub Language (text) (Note: 'dual (jap/[lang2])' is replaced with 'jap&[lang2]')
:* D = Dub language (text) (Note: 'dual (jap/[lang2])' is replaced with 'jap&[lang2]')
:* S = Sub Language (text)
:* S = Sub language (text)
There is atm no support for wildcards, but lists (A,B,C,D), for strings and numbers, and ranges (0-1999,2001-3000), on numbers, is supported. ',' means OR. '!' means NOT.
:* P = file Path (starts with).
:* E = file Extension.
:* N = geNre (one of).
There is atm no support for wildcards, but lists (A,B,C,D), for strings and numbers, and ranges (0-1999,2001-3000), on numbers, is supported. ',' means OR. '!' means NOT. ';' means AND.


===Tags===
===Tags===
Line 152: Line 164:
%gid Group ID
%gid Group ID
</pre>
</pre>
== Local database ==
From 1.14 mysql db is supported.
How to:
:* Download and install mysql (http://dev.mysql.com/downloads/mysql/5.0.html). Be sure to select unicode support.
:* Download Connector/J (http://dev.mysql.com/downloads/connector/j/3.1.html) and extract the jar file to '{java path}/jre{version}/lib/ext'.
:* Download and extract webaom db def (http://www.hostunlim.com/epoximator/webaom-sql.rar).
:* Create db:
::* mysql -u{usr} -p{psw}
::* create database {webaom}; exit;
::* mysql -u{usr} -p{psw} {webaom} < webaom.sql
:* Start WebAOM and write the jdbc url into 'My Database' text field: "jdbc:mysql://{host}/{webaom}[?user={usr}][&password={psw}]
::* {host} is the url or ip to the host. (localhost/127.0.0.1)
::* {webaom} is the name of the database. Can be whatever you like.
::* {usr} is the username. Optional. 'root' is assumed.
::* {psw} is the password. Optional. No password is assumed.
:* Press enter (in text field).
::* This must be done every time you start WebAOM. Should be done before adding any files.
::* All jobs in db that are not finished will be loaded at this point.
::* If you want to load info on finished files you must use the Add file/folder buttons.


== Changelog ==
== Changelog ==
<pre>
<pre>
1.14 30.10.2005
-Cleanup. A lot of internal changes (in job handling / html parsing / data structures).
-Added support for private/local mysql database.
-Added support for path 'P', extension 'E' and genre 'N' in tests. Former 'E' (english title) is now included in 'A'.
-Added support for ELSE IF and RETURN in scripts.
-Added coloring, sorting, aid and gid columns, in job table.
-Added new file info frame, html style.
-Added Pause, Restore name, Rehash, Identify, Add to mylist, Set Finished, Set Folder to job popup menu.
-Changes in debug window.
1.13 26.09.2005
1.13 26.09.2005
-Change in Rule system. Scripting. Textfield instead of table.
-Change in Rule system. Scripting. Textfield instead of table.

Revision as of 14:48, 1 November 2005

Author: epoximator
OS: Java VM
Main Features:

  • ed2k, crc32, md5, sha1, tth hashing
  • file add to mylist
  • custom file renaming and moving
  • local / private mysql database support

Current Version hosted by AniDB:

Current Version hosted by epoximator:

Old versions:

Introduction

WebAOM is a simple java applet/application that hash files and add them to your mylist at AniDB. It is made for those who don't want to or cannot install Anidb-O-Matic. The name may be inaccurate/misleading since it does not replace AOM in any way. It is based on the UDP-API and is therefore limited.

All questions, feature requests and bug reports can be pm'ed to epoximator.

Screenshots

Documentation

Buttons

  • Wiki : Link to this page.
  • Files... : Add specific files for hashing. (Only those with extensions specified in "Wanted File Extensions" are added.)
  • Folders... : Add folder(s) with all including files for hashing.
  • Toggle fileIO : Start/stop hashing and moving thread.
  • Toggle netIO : Start/stop communication thread.
  • Save Log : Save the Log to disk (in HTML format).
  • Save Options: Save options to "%home/.webaom".
  • Ping AniDB : Check reachability to AniDB. (UDP server that is.)

Tabs

  • Rules: Rule system. See Move/Rename system.
  • Options : All options.
  • Jobs: Table of files/work.
  • Log : The log. What's going on. History.
  • Hash : All selected checksums are printed here.
  • Info : Some info about the client. Changelog.
  • Debug : Low level communication and exceptions are printed here.

Options

  • Connection
  • Offline Mode : No communication with AniDB. Adding and renaming are disabled if checked.
  • AniDB Host : URL to AniDB can be set here.
  • Remote Port : Remote Port can be set here.
  • Local Port : Local Port can be set here. Necessary if the default port is used by another application on your system.
  • Delay (sec) : Delay between each datagram sent to server. 3 seconds is minimum. Should be set higher if connection is poor or if much work is queued.
  • Timeout (sec) : Timeout on receiving reply from AniDB.
  • File Options
  • Other
  • Hash Dirs : Default directories to hash. Checked every time Hasher starts. Directories are separated with ";".
  • Browser Path : Set path to internet browser manually here. For Linux users.
  • My Database : JDBC url to local / private database.
  • Renaming : Combobox for selecting renaming mode.
  • Hash functions : ED2K CRC32 MD5 SHA1 TTH
  • Wanted File Extensions : Default are avi, ogm, mkv, mp4.
  • Rename Options (removed in 1.09)
  • Combobox for custom renaming. (More schemes can be added on request.)
  • Rename files own style : Uses selected scheme in combobox. Default: {group short name}_{anime name}_{episode #}_{crc32}{file version if greater than 1}.{file extension}
  • Rename files AniDB style : Uses default AniDB scheme: {anime name} - {episode #} - {episode name} - {group short name}.{file extension}
  • Replace illegal characters : Replaces illegal characters defined in the table beneath. Also used to change ' ' to '_'.
  • Hashes in uppercase : Uppercase hashes in filename. Only possible when own style is selected.

Job Menu (Popup)

  • Pause : Pause / unpause job.
  • Show Info : Show info about a file/job. (double click)
  • Watch Now : Watch with default media player. Windows only. (alt + double click)
  • Explore Folder : Open parent folder with Explorer. Windows only.
  • Rehash : Use this if you want rehash and include other hash types. (Must be selected in 'Other' options.)
  • Identify : Re-identify the file. Can be used on 'Unknown' files to check if they are added to anidb.
  • Add to mylist : Add job manually if you forgot to check 'Add files to mylist'.
  • Apply Rules : If the rules are changed after a job is finished, they can be applied again manually.
  • Set Finished : If you don't want to bother with a troublesome file, just set it as finished.
  • Restore Name : Rename file to its original name.
  • Set Folder : Move file to a specific folder. Can also be used to find files when 'File not found'.
  • Remove from DB : Remove job from local database. Will be readded if used twice.

Move/rename system

A new feature from 1.09 is moving and renaming of files based on rules. This is implemented to ease administration of your anime files. The system may seem confusing at first, but it is actually pretty simple. Since the system performs virtually no error checking on the input you provide, it is recommended that you understand the system fully before using it.

Notice that the system is under development. Expect radical changes. Feel free to request changes / comment.

Scripting

For renaming and moving files WebAOM needs schemas. A schema i just a string with tags, where each tag corresponds to file/anime data. Ex: "%ann - %enr [%crc]". (See tag chart below.) The point with the rule system is that you can customize these schemas so different types of files can be renamed different ways, and moved to different locations. To build the schemas you have to write two simple scripts; one for renaming and one for moving. Example on rename schema:

IF A(Naruto) DO FAIL //Do not rename file if it is Naruto
DO ADD '%eng (%ann) - %enr - %epn ' //Add the base, same for all files
IF D(japanese);S(english) DO ADD '(SUB)' //Add (SUB) if the file is subbed in english
IF D(japanese);S(none) DO ADD '(RAW)' //Add (RAW) if the file is not subbed.
IF G(!unknown) ADD '[%grp]' //Add group name if it is not unknown
DO ADD '(%CRC)' //Always add crc
#this would create the schema "%eng (%ann) - %enr - %epn (SUB)[%grp](%CRC)" for a normal subbed file.

>'< around parts is not required. Example on move schema:

IF R(DVD,HKDVD) DO ADD 'M:\dvd\'
ELSE DO ADD 'N:\tv\'
IF Y(0-1999) DO ADD '199X\%year - %ann [%eps]'
ELSE DO ADD '%year\%ann [%eps]'
IF G(!unknown) DO ADD '[%grp]\'
ELSE DO ADD '\'

Syntax for each line in a script:

  • [[ELSE] IF {test}/ELSE] DO ADD {part}/SET {part}/FAIL/FINISH [{last part}]/RETURN {complete schema}
  • ADD means +=
  • SET means =
  • FAIL means return null;
  • FINISH means return result; Also possible to add last part. (Not needed as last line.)
  • RETURN means return complete schema (for exceptions).
  • DO is always required.
  • !!! CASE SENSITIVE !!!

Possible tests

  • A = Anime (text/number) [*/#] Anime Name/Title (Romaji/Kanji/English) or aid.
  • G = Group (text/number) [unknown, */#] Short name or gid.
  • Q = Quality (text) [unknown, very high, high, med, low, very low, corrupted, eyecancer]
  • R = ripSource (text) [unknown, camcorder, TV, DTV, VHS, VCD, SVCD, LD, DVD, HKDVD, www]
  • T = Type (text) [unknown, TV, OVA, Movie, Other, web]
  • Y = Year (number) [#]
  • D = Dub language (text) (Note: 'dual (jap/[lang2])' is replaced with 'jap&[lang2]')
  • S = Sub language (text)
  • P = file Path (starts with).
  • E = file Extension.
  • N = geNre (one of).

There is atm no support for wildcards, but lists (A,B,C,D), for strings and numbers, and ranges (0-1999,2001-3000), on numbers, is supported. ',' means OR. '!' means NOT. ';' means AND.

Tags

%ann Anime Name / Title
%kan Jap. Kanji Title
%eng English Title
%epn Episode name
%enr Episode number
%ed2k / %ED2K
%md5 / %MD5
%sha / %SHA
%crc / %CRC
%ver Version string
%cen Censored string
%dub Dub language
%sub Sub language
%grp Group short name
%qual Quality
%src Source
%res Resolution
%vid Video codec
%aud Audio codec
%year
%eps Total number of episodes
%type [unknown, TV, OVA, Movie, Other, web]
%fid File ID
%aid Anime ID
%eid Episode ID
%gid Group ID

Local database

From 1.14 mysql db is supported.

How to:

  • mysql -u{usr} -p{psw}
  • create database {webaom}; exit;
  • mysql -u{usr} -p{psw} {webaom} < webaom.sql
  • Start WebAOM and write the jdbc url into 'My Database' text field: "jdbc:mysql://{host}/{webaom}[?user={usr}][&password={psw}]
  • {host} is the url or ip to the host. (localhost/127.0.0.1)
  • {webaom} is the name of the database. Can be whatever you like.
  • {usr} is the username. Optional. 'root' is assumed.
  • {psw} is the password. Optional. No password is assumed.
  • Press enter (in text field).
  • This must be done every time you start WebAOM. Should be done before adding any files.
  • All jobs in db that are not finished will be loaded at this point.
  • If you want to load info on finished files you must use the Add file/folder buttons.

Changelog

1.14 30.10.2005
-Cleanup. A lot of internal changes (in job handling / html parsing / data structures).
-Added support for private/local mysql database.
-Added support for path 'P', extension 'E' and genre 'N' in tests. Former 'E' (english title) is now included in 'A'.
-Added support for ELSE IF and RETURN in scripts.
-Added coloring, sorting, aid and gid columns, in job table.
-Added new file info frame, html style.
-Added Pause, Restore name, Rehash, Identify, Add to mylist, Set Finished, Set Folder to job popup menu.
-Changes in debug window.

1.13 26.09.2005
-Change in Rule system. Scripting. Textfield instead of table.
-Fixed two bugs in parsing code thx to egg.
-Fixed padding for specials thx to egg.

1.12 24.09.2005
-Added extra '0' padding in epnr when an anime serie got more than 99 episodes.
  Will only work when total num of eps is known.
-Added support for dub language (D) and sub language (L) in tests.
-Added support for NOT (!) in tests.
-Added tags %kan = Jap. Kanji Title and %eng = English Title. (If null then %ann is used.)
-Added support for hentai (needs to be enabled in profile: http://anidb.info/perl-bin/animedb.pl?show=profile).
-Fixed some minor bugs.

1.11 22.09.2005
-Fixed bug in rule system: Test 'A' did not work.
-Fixed some minor bugs thx to hrm.
-Added combobox 'Renaming' for selection of renaming mode.
-Change in file handler: Will not try to add files that are locked (used by another process).

1.10 15.09.2005
-Fixed bug where Job is not set to Finished (when rename/moving is enabled but not needed).
-Fixed parsing bug. (Movies has parts, not episodes.)
-Fixed minor gui bugs.
-Added slider for delay between datagrams sent to server (3-10 sec).
-Added updating of progress bar when checking crc (after move).
-Added updating of second progress bar (total progress).

1.09 09.09.2005
-Fixed rename bug when group is "raw/unknown" (gid=0). These are now just called "unknown".
-Added possibility to save options.
-Added new rule system: rename and move files based on file info.
-Significant changes in gui and underlying system.
  -File lists replaced with one table. 
  -Rename option panel replaced with Rules tab. 
  -Start and Stop buttons replaced with toggle buttons for hasher thread and communication thread.
-Added timeout slider for UDP communication (20-60 sec).
-Added "Hash Dirs", "Browser Path" and "My Database" text fields.
-Added Wiki button. (Works only on Windows systems, unless browser path is defined.)

1.08 05.07.2005
-Updated mylist file states.
-Updated file info parser (renamer was broken).

1.07 12.06.2005
-Updated the second progress bar.
-Changed comm. thread sleeping routine.
-Changed file info dialog to a text dialog.
-Added Tiger Tree Hash.
-Added possibility to choose each hash type.
-Added debug tab.
-Made 1.4.2 comp again thx to gyrojoe.

1.06 29.05.2005
-Changed the way files are hashed and added to mylist. This is now done concurrent.
-Changes in the status and logging system. 
-Fixed some minor bugs. 

1.05 14.05.2005
-Added custom renaming of files thx to ExElNeT.
-Added some more checking on username and password.
-Changes in option tab.

1.04 11.05.2005
-Added extra file information thx to ExElNeT. Double click rows in 'Finished Files' to see.
-Added offline mode
-Fixed two bugs in file rename code. thx to ExElNeT and visnu

1.03 19.02.2005
-Added extensive hashing. MD5, SHA-1 and CRC32
-Changes in the error handler.
-Bugfix: Applet crash with Opera and Firefox

1.02 04.02.2005
-Added connection options.
-Added connection check.

1.01 30.01.2005
-New layout, options in own tab.
-Added "Source" and "Other" string for AniDB file info.
-Added possibility to save the log.
-Added illegal character replacement customization.
-Added recursive directory search.
-Added new filehandler.
-Bugfix in AniDBConnection.

1.00 23.01.2005
-First version.