Nzbirc/v1

From tiberious.org

Main_Page > NZBirc > v1

Contents

NZBirc v1

v1.4 has been relased - 10th January 2009


Nzbirc/guide - Installation and configuration guide


Download

Releases

Stable

Beta

Install

From Debian Package

Using repository

  1. Goto https://launchpad.net/~nzbirc/+archive/ppa
  2. Select your release of choice (for debian users, select any)
  3. Copy the sources.list entries
  4. Open your sources.list file (/etc/apt/sources.list)
  5. Paste the entries from the website
  6. run: apt-get update
  7. run: apt-get install nzbirc

This will install all the required pre-requesites, and will keep the software up-to-date

Using .deb file

  1. goto https://launchpad.net/~nzbirc/+archive/ppa or https://launchpad.net/nzbirc/+download
  2. download the latest .deb file
  3. ensure you have all the dependencies installed
php5-cli, php-pear, php-http-request, php-xml-serializer, php5-xmlrpc
  1. run: dpkg -i nzbirc_[version].deb


From Source

Nzbirc/guide/installation

Download and extract the archive into an appropriate directory.

Prerequesites:

php-cli >=4 - http://www.php.net

[if php 4] php4-xml

PEAR - http://pear.php.net

To install the pear packages use the command:

pear install --alldeps http_request xml_serializer-beta

Recommended:

hellanzb - http://www.hellanzb.com

pear install --alldeps xml_rpc

Optional:

PECL Runkit - http://pecl.php.net/package/runkit

pecl install runkit

Future Releases

v2 Release

0% Complete

  • SmartIRC
    • Make it able to connect to multiple servers
  • Modules
    • autotv
      • Add your own times for when shows air (for when tvrage is wrong/doesnt have them or doesnt have the show) [i.e. stargate atlantis is being show in canada]
      • Reminders for when shows airs
      • ignore nzb function: so it does not download the specified id's, and re-attempts some epiosde downloads
    • store
      • Devise method of cross program communication through a file, that is fail safe
        • idea1: keep a last updated time, so when updating a variable, check the file to see if it has been updated after what it thinks it is at, and merge [problems with deleting entries & merging of changed data (which one to use) -> has to be autotmatic]
        • idea2: force push updates to clients reading the file, when it is updated [no idea how, most likely impossible]
        • idea3: store a history of operations and timeline, and sync using that [tricky]
        • idea4: each variable gets its own xml file, before doing any operations on particular variables they are read in first [easy, could be computationally expensive, still prone to some errors]
      • when adding variables, register a change callback command, so scanning is not neccessary
    • nzb
      • Change when it sends data to the worker thread, till after it has checked for report existance etc, for quicker error reports
      • make a history log for each nzb file (queued, started downloading, finished downloading, moved to ..., etc)
    • hella
      • Change priority to a numerical 0-10 based system, and auto sort the queue (upon adding a new entry with a numerical value, the position of the post also has a factor in where the item is placed)
      • Somehow put rate scheduling into the worker, if only running website
  • RSS Reader
  • Post Processor

v3.0 Release

  • Restructure
    • base daemon
    • Interfaces
  • Automatic module downloading & updating

Extra Modules

  • tv - TV listings gathered from xmltv [1]


NZBirc v1.3

  • See #Install for installation requirements and instructions

Download

Modules

Commands

  • rehash [module] - Reload all or one particular module (if any changes are made to your code, they will be applied)
  • respawn - Respawn the worker thread
  • kill - Kill the program

Module: nzb

An interface for http://www.newzbin.com

Default Triggers: !nzb and nzb

  • [force/next]add query [f:flags] - Download nzb files based on the query, which can be one or more NZBid's, a search query or a standard url, if flags are specified, it attempts to download the best quality version
  • +/!/^/-nzbid [+/!/^/-nzbid2 [...]] - the same as add/del, but it will only accept nzbID's from newzbin.com, + adds, ! adds and forces, ^ adds and places next in the queue, - deletes, (!,^ and - depend on HellaNZB)
  • search query [f:flags] - Searches newzbin based on the query, if flags are specified, the results are sorted based on their flags
  • info nzbid [nzbid2 [...]] - Obtain information about a newzbin report, from its ID
  • history times - Return the nzb's downloaded on the specified times

Module: tvnzb

Interface with http://www.tvnzb.com

Default Triggers: !tvnzb and tvnzb

  • [force/next]add query [f:flags] - Download nzb files based on the query, which can be one or more tvnzb id's or a tv show query, if flags are specified, it attempts to download the best quality version
  • search query [f:flags] - Searches tvnzb based on the query, if flags are specified, the results are sorted based on their flags
  • history times - Return the nzb's downloaded on the specified times

Module: hella

An interface to HellaNZB

Default Triggers: !nzb and nzb

  • cancel - Cancel the current nzb being downloaded
  • status - Get the current status of Hellanzb
  • list [query] [p:position] [u:user] [l:limit] [i:id] - List items currently in HellaNZBs Queue
  • pause [duration] - Pause the downloads, if a duration is specified (in format Xh Ym etc) then it will become unpaused after that time, Default length: 1 hour
  • unpause/continue/resume - Resume downloading
  • force query - Immediatly downloads an item in the queue, query can be a HellaNZB ID, newzbin ID, or part of the name of an item
  • next/front query - Move an item to the front of the queue, query can be a HellaNZB ID, newzbin ID, or part of the name of an item
  • last/end query - Moves an item to the end of a queue, query can be a HellaNZB ID, newzbin ID, or part of the name of an item
  • move query position - Move an item defined in query to position in the queue, query can be a HellaNZB ID, newzbin ID, or part of the name of an item
  • rate/maxrate [newrate] - Set the maximum rate of HellaNZB in Kb/s, a value of 0 means unlimited
  • rate/maxrate add speed time - Add a new entry into the rate scheduler, these will automatically alter the speed hellanzb downloads at, at different times of the day, time is in stardard time formats (ie: 09:00pm)
  • rate/maxrate list - List the current rate scheduler entries
  • rate/maxrate del time - Delete an entry from the rate scheduler, that matches time.

Module: autotv

Automatically download TV episode when they air

Default Triggers: !autotv and autotv

  • add show [f:flags] - Add the show to the auto download list, flags determine the quality of reports to download
  • del show - Delete a show from the auto download list
  • edit show [setting] [=/+/- value] - View or change a shows settings, if =, + or - are specified, the setting is modified. This works the same way as the config module
  • list [show] [times] - List information about a show, if no show is specified, information about all the shows are shown, times can be used to limit the results
  • update show - Perform a manual update on a particular show
  • history times - Return the nzb's downloaded using the auto downloader on the specified times

Module: autoquery

Automatically download from the query specified

Default Triggers: !autoquery and autoquery

  • add query [f:flags] - Add the query to the auto download list, flags determine the quality of the reports to download
  • del query - Delete a query from the auto download list
  • list [query] - List information about a query, if not query is specified, information about all the queries are shown
  • update query - Perform a manual update on a particular query

Module: tvrage

Interface with http://www.tvrage.com

Default Triggers: !tvrage and tvrage

  • show - List information about a show
  • show SxEE - List information about a particular episode (S=series, EE=episode)
  • show, episode - Search for an episode matching episode and list the information

Module: imdb

Interface with http://www.imdb.com

Default Triggers: !imdb and imdb

  • film - List information about a film

Module: ed

Smart parsing of filenames to determine information

Default Triggers: !ed and ed

  • filename/postname - Looks at the filename, or general posting information from a usenet post and, if it is TV or a Movie, determines the show, series, episode, title, source, format, genre, resolution and audio format

Module: config

On the fly editing of the config file

Default Triggers: !config and config

Note: Admin only

  • module [variable] - Get a configuration variable, module can be irc, or the name of a module
  • module variable =/+/- value - Set a config variable, module can be irc, or the name of a module, variable is the pathway to the variable. If the variable is an array, use + and - to add or remove entries