moparisthebest/filebot
1
0
Fork 0
mirror of https://github.com/mitb-archive/filebot synced 2024-10-31 15:35:06 -04:00
Code Issues Releases Wiki Activity
5313fc081d
filebot/website/script.html
Reinhard Pointner 248c774fd4 Use redirects for external resources
2017-06-08 17:07:14 +08:00

214 lines
15 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" itemscope itemtype="http://schema.org/Product">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<meta name="keywords" content="@{package.tags}" />
<title>Scripts and Automation</title>
<meta name="description" content="FileBot scripting allows to easily write scripts for any kind of automation in Groovy. There is no limits. Extract archives, download subtitles, rename episodes, fetch artwork and banners and delete left-behind clutter. All in one go." />
<meta itemprop="name" content="FileBot Scripting and Automation" />
<meta itemprop="description" content="FileBot scripting allows to easily write scripts for any kind of automation in Groovy. There is no limits. Extract archives, download subtitles, rename episodes, fetch artwork and banners and delete left-behind clutter. All in one go." />
<meta itemprop="image" content="@{link.image.logo}" />
<link rel="stylesheet" href="base.css" type="text/css" />
<link rel="stylesheet" href="code.css" type="text/css" />
<link rel="icon" href="favicon.png" />
</head>
<body>
<div class="page">
<div class="navigation">
<div>
<ul>
<li><a href="https://www.filebot.net/forums/">Forums</a></li>
<li><a href="https://www.filebot.net/forums/viewtopic.php?f=3&amp;t=7">FAQ</a></li>
<li><a href="https://www.filebot.net/#download">Download</a></li>
</ul>
</div>
</div>
<div class="header">
<a href="https://www.filebot.net/"><img class="logo" alt="logo" src="images/filebot.logo.svg" width="64" height="64" /></a>
<h1>
Scripts and Automation
<span class="description">Scripting interface usage manual</span>
</h1>
</div>
<div class="content">
<div class="section screenshot" style="border:none; box-shadow:none; background:white; margin-left: 20px">
<a href="https://github.com/filebot/scripts" target="_blank"><img alt="See Examples" src="images/script.png" /></a>
<span class="quote">Anything is possible</span>
</div>
<div class="section about">
<h2>About</h2>
<p>
FileBot makes scripting and automation as easy as it gets. Just script everything in <a href="http://groovy-lang.org/">Groovy</a>
instead of bothering with cumbersome cmd and bash scripts. It's the same on all platforms and much more powerful.
The provided <a href="#functions">functions</a> are the same as in the <a href="cli.html">CLI</a> and <a href="cli.html#arguments">parameter usage</a>
is also exactly the same.
</p>
<h2 id="overview">Examples</h2>
<h3 id="usage">Running Scripts</h3>
<p>
<code><span class="cmd">filebot</span> <span class="option">-script</span> <span class="argument">"path/to/script.groovy"</span> <span class="argument">args...</span></code>
Execute a given Groovy script. Parameters defined on the cmdline when starting a script will serve as default parameters
while running that script.
</p>
<h3 id="repository">Script Repository</h3>
<p class="description">
Find scripts for common tasks <a href="https://www.filebot.net/forums/viewtopic.php?f=4&amp;t=5#p5">here</a>. You can just use these scripts straight
away or as a reference for building your own more advanced scripts. If you wrote a really useful script
please <a href="https://www.filebot.net/forums/viewtopic.php?f=4&amp;t=5">share it with us</a>.
</p>
<div style="margin: 12px 300px 20px 25px; padding: 5px; border: thin dotted lavender; background: #FDFDFF">
<span style="text-decoration: underline">Script Index:</span><ul style="margin:3px"><li><a href="https://www.filebot.net/forums/viewtopic.php?f=4&amp;t=215" class="postlink">Automated Media Center</a></li><li><a href="https://www.filebot.net/forums/viewtopic.php?f=4&amp;t=5#p204" class="postlink">Fetch Artwork and Nfo for TV Shows</a></li><li><a href="https://www.filebot.net/forums/viewtopic.php?f=4&amp;t=5#p205" class="postlink">Fetch Artwork and Nfo for Movies</a></li><li><a href="https://www.filebot.net/forums/viewtopic.php?f=4&amp;t=5#p8871" class="postlink">Fetch subtitles for all files</a></li><li><a href="https://www.filebot.net/forums/viewtopic.php?f=4&amp;t=5#p1341" class="postlink">The Cleaner - Delete left over files and folders</a></li><li><a href="https://www.filebot.net/forums/viewtopic.php?f=4&amp;t=5#p2459" class="postlink">Query Rename History</a></li><li><a href="https://www.filebot.net/forums/viewtopic.php?f=4&amp;t=5#p2485" class="postlink">Revert Renamed Files to their Original Names</a></li><li><a href="https://www.filebot.net/forums/viewtopic.php?f=4&amp;t=5#p5394" class="postlink">View or Clear Extended Attributes</a></li><li><a href="https://www.filebot.net/forums/viewtopic.php?f=4&amp;t=5#p2211" class="postlink">Rename All Media Folder by Folder</a></li><li><a href="https://www.filebot.net/forums/viewtopic.php?f=4&amp;t=5#p7188" class="postlink">Convert Absolute to SxE numbers</a></li><li><a href="https://www.filebot.net/forums/viewtopic.php?f=4&amp;t=5#p2100" class="postlink">Filename: Find &amp; Replace</a></li><li><a href="https://www.filebot.net/forums/viewtopic.php?f=4&amp;t=5#p53" class="postlink">Media Index CSV</a></li><li><a href="https://www.filebot.net/forums/viewtopic.php?f=4&amp;t=5#p12396" class="postlink">Verify File Integrity</a></li><li><a href="https://www.filebot.net/forums/viewtopic.php?f=4&amp;t=5#p19132" class="postlink">Find missing Episodes</a></li><li><a href="https://www.filebot.net/forums/viewtopic.php?f=4&amp;t=5#p23171" class="postlink">Find Duplicate Movie or Episode Files</a></li></ul>
</div>
<h3 id="examples">Example Scripts</h3>
<div class="description">
<pre><code>args.<span class="method">eachMediaFolder</span> {
<span class="method">getMissingSubtitles</span>(<span class="property">folder</span>:it)
<span class="method">rename</span>(<span class="property">folder</span>:it)
<span class="method">compute</span>(<span class="property">file</span>:it.<span class="method">listFiles</span>{ it.<span class="method">isVideo</span>() })
}</code></pre>Fetch subtitles, rename and compute checksums for all media folders in the file hierarchy.</div>
<div class="description">
<pre><code>[<span class="string">'E:/TV Shows'</span> as File].<span class="method">eachMediaFolder</span>{ <span class="method">rename</span>(<span class="property">folder</span>:it, <span class="property">db</span>:<span class="string">'TheTVDB'</span>) }
[<span class="string">'E:/Anime'</span> as File].<span class="method">eachMediaFolder</span>{ <span class="method">rename</span>(<span class="property">folder</span>:it, <span class="property">db</span>:<span class="string">'AniDB'</span>) }
[<span class="string">'E:/Movies'</span> as File].<span class="method">eachMediaFolder</span>{ <span class="method">rename</span>(<span class="property">folder</span>:it, <span class="property">db</span>:<span class="string">'TheMovieDB'</span>) }
</code></pre>Run rename on different folder hierarchies using different episode/movie datasources.</div>
<div class="description">
<pre><code>args.<span class="method">getFiles</span>{ it.<span class="method">isVideo</span>() }
.<span class="method">sort</span>{ a, b -> a.name.<span class="method">compareTo</span>(b.name) }
.<span class="method">each</span>{ println <span class="method">getMediaInfo</span>(<span class="property">file</span>:it, <span class="property">format</span>:<span class="string">'{fn} [{vf} {vc} {af}]'</span>) }
</code></pre>Print media info for all video files using the given format pattern.</div>
<h2 class="reference" id="functions">
Function Reference
<a href="https://github.com/filebot/filebot/blob/master/source/net/filebot/cli/ScriptShellBaseClass.java" class="source" target="_blank">source</a>
</h2>
<div class="documentation">
<h4>Rename media files</h4>
<pre><span class="return">File[]</span> <span class="method">rename</span>(<span class="property">folder</span>|<span class="property">file</span>, <span class="property">query</span>, <span class="property">output</span>, <span class="property">format</span>, <span class="property">db</span>, <span class="property">lang</span>, <span class="property">strict</span>)</pre>
<div class="text">Match files with episode/movie data and rename according to given naming scheme.</div>
<dl>
<dt>Parameters:</dt>
<dd><span class="property">folder</span> - process media files in this folder</dd>
<dd><span class="property">file</span> - process these media files</dd>
<dd><span class="property">action</span> - rename action name or closure</dd>
<dd><span class="property">conflict</span> - define conflict handling</dd>
<dd><span class="property">output</span> - output folder, if format expression is not absolute</dd>
<dd><span class="property">format</span> - episode/movie naming scheme</dd>
<dd><span class="property">db</span> - episode/movie database</dd>
<dd><span class="property">query</span> - force series/movie name, auto-detect if not set</dd>
<dd><span class="property">sortOrder</span> - episode sort order</dd>
<dd><span class="property">filter</span> - episode filter expression</dd>
<dd><span class="property">lang</span> - preferred language for episode/movie titles</dd>
<dd><span class="property">strict</span> - turn on/off strict matching</dd>
</dl>
</div>
<div class="documentation">
<h4>Fetch subtitles for media files</h4>
<pre><span class="return">File[]</span> <span class="method">getSubtitles</span>(<span class="property">folder</span>|<span class="property">file</span>, <span class="property">query</span>, <span class="property">lang</span>, <span class="property">output</span>, <span class="property">encoding</span>, <span class="property">strict</span>)</pre>
<div class="text">
Download subtitles for the given files. Lookup subtitles via hash or match by filename. If you only want to download
missing subtitles you should use <pre style="font-size:inherit;display:inline"><span class="method">getMissingSubtitles</span></pre>
so subtitles that have already been downloaded will not be downloaded again overridding existing subtitle files.
</div>
<dl>
<dt>Parameters:</dt>
<dd><span class="property">folder</span> - process media files in this folder</dd>
<dd><span class="property">file</span> - process these media files</dd>
<dd><span class="property">db</span> - database filter expression (e.g. opensubtitles|subscene)</dd>
<dd><span class="property">query</span> - lookup subtitles by series/movie name</dd>
<dd><span class="property">lang</span> - subtitle language</dd>
<dd><span class="property">output</span> - force output format (e.g. srt)</dd>
<dd><span class="property">encoding</span> - force output charset</dd>
<dd><span class="property">strict</span> - enable matching subtitles via filename</dd>
</dl>
</div>
<div class="documentation">
<h4>File verification</h4>
<pre><span class="return">boolean</span> <span class="method">check</span>(<span class="property">folder</span>|<span class="property">file</span>)</pre>
<div class="text">Check given sfv/md5/sha1 files.</div>
<dl>
<dt>Parameters:</dt>
<dd><span class="property">folder</span> - check the sfv/md5/sha1 files in this folder</dd>
<dd><span class="property">file</span> - check these sfv/md5/sha1</dd>
</dl>
<hr/>
<pre><span class="return">File</span> <span class="method">compute</span>(<span class="property">folder</span>|<span class="property">file</span>, <span class="property">output</span>, <span class="property">encoding</span>)</pre>
<div class="text">Compute sfv/md5/sha1 for the given files.</div>
<dl>
<dt>Parameters:</dt>
<dd><span class="property">folder</span> - compute checksums for files in this folder</dd>
<dd><span class="property">file</span> - compute checksums for these files</dd>
<dd><span class="property">output</span> - absolute or relative output file or just output format (sfv, md5 or sha1)</dd>
<dd><span class="property">encoding</span> - output charset, defaults to UTF-8</dd>
</dl>
</div>
<div class="documentation">
<h4>Other</h4>
<pre><span class="return">File[]</span> <span class="method">extract</span>(<span class="property">folder</span>|<span class="property">file</span>, <span class="property">output</span>)</pre>
<div class="text">Extract files from single-volume or multi-volume archives (.zip, .rar, .7z, etc).</div>
<dl>
<dt>Parameters:</dt>
<dd><span class="property">folder</span> - extract all archives that are in this folder</dd>
<dd><span class="property">file</span> - extract this archive</dd>
<dd><span class="property">output</span> - output folder, defaults to archive path</dd>
<dd><span class="property">conflict</span> - define conflict handling</dd>
</dl>
<hr/>
<pre><span class="return">String[]</span> <span class="method">fetchEpisodeList</span>(<span class="property">query</span>, <span class="property">format</span>, <span class="property">db</span>, <span class="property">lang</span>)</pre>
<div class="text">Fetch episode data for the given tv show and format episode names.</div>
<dl>
<dt>Parameters:</dt>
<dd><span class="property">query</span> - tv series name</dd>
<dd><span class="property">format</span> - episode naming scheme</dd>
<dd><span class="property">db</span> - episode database</dd>
<dd><span class="property">sortOrder</span> - episode sort order</dd>
<dd><span class="property">lang</span> - preferred language for episode titles</dd>
</dl>
<hr/>
<pre><span class="return">String</span> <span class="method">getMediaInfo</span>(<span class="property">file</span>, <span class="property">format</span>)</pre>
<div class="text">Get mediainfo as defined by the given format.</div>
<dl>
<dt>Parameters:</dt>
<dd><span class="property">file</span> - get info for this file</dd>
<dd><span class="property">format</span> - media naming scheme</dd>
</dl>
</div>
<div class="documentation">
<h4>Extras</h4>
<div>
<a href="https://github.com/filebot/filebot/blob/master/source/net/filebot/cli/ScriptShellMethods.java">ScriptShellMethods</a> also defines lots of extra useful functions
and there is example code in the <a href="https://github.com/filebot/scripts">script repository</a>.
</div>
</div>
</div>
<p class="suggestion">
Need some help getting started? Check the <a href="https://www.filebot.net/forums/viewforum.php?f=4">forums</a>.
</p>
<div class="metrics">
</div>
<div class="footer">
<p>Hosted on <a href="https://www.filebot.net/">filebot.net</a> | Creative Commons License: Attribution-NonCommercial-ShareAlike © @{tstamp.year}</p>
</div>
</div>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink