DISCLAIMER: Use at your own risk. This is not set in stone, and is not the final draft or outline. Once the project is complete, nothing will be released, until testing is complete.
Folder Outline
· ./install
a. Contains the installation files
· ./lib
a. Libraries, and other backend things.
· ./Sources
a. Source files for calls to the ?action=command
· ./torrents
a. More or less what the name says, stores the torrents in $id.torrent form.
· ./Themes
a. Root for the site themes
Root ./
· index.php
o index
· Settings.php
o Contains all site Settings. Everything can be called through the variable $XConfig.
· SSI.php
o This is for outside calls, such as for creating plugins. (Like an API)
./lib
· Benc.class.php
o Bencode and decode files.(No CALLS TO THIS FILE EXCEPT THROUGH Torrents.class.php)
· Breadcrumbs.class.php
o Class for creation of breadcrumbs. (ie. Home->Music->Industrial)
· Categories.class.php
o Creates the categories by levels into an array.
· Cleanup.class.php
o CRON JOB file to clean up the sessions, unused torrent, and other temporary files
· DB.class.php
o Our database class(Everything is public)
o Handles the following calls
§ ->myConnect()
§ ->myQ(Query)
§ ->myF(Result)mysql_fetch_array
§ ->myFAS(Result)mysql_fetch_assoc
§ ->myFRow(Result)mysql_fetch_row
§ ->myNum(Result)mysql_num_rows
§ ->myFree(Result)mysql_free_result
§ ->myEscape(Result)mysql_real_escape_string
§ ->myClose() mysql_close()
· Library.class.php
o Just kinda a list of the files in the directory
· RSS.class.php
o Handles and parses requests to create RSS feeds. Not for API things.
· Security.class.php
o Our watchdog for XSS, hackers and other interesting things
· System.class.php
o Creates the backend system, variables, database class setup, security setup and other things to keep everything smooth.
· Time.class.php
o The time system. Time zone offsets, conversion, and parsing.
· Torrents.class.php
o Gets, creates, and parses torrents upon upload, fetching, and downloading.
· User.class.php
o Handles all user requests. Profiles, settings, and subscriptions.
./Sources
· About.php
o Contains copyright, TOS, Privacy policy, and other things.
o Calls done: ?action=about&type=$type
· Browse.php
o Allows users the search, and browsing option through the categories, rating, and other advanced searching options.
o Calls done: ?action=browse&vars=vars
· Comments.php
o Handles all comments.
o Calls done: ?action=comments&id=commentID&torID=torID
· Feeds.php
o Handles the RSS feeds, and all other calls to XML docs
o Calls done: ?action=feed&type=(.xml/.json)&kind=(com/tor/news)&cat=$this
· Forums.php
o Handles all actions to the Forum. Posting and everything.
o Calls done: ?action=forum&fact=(post/edit/view/delete)&id=$this
· Help.php
o Contains all help documentation for the site.
o Calls done: ?action=(help/faq)
· Load.php
o Loads the system.
o No outside calls
· Login.php
o Handles login, register, forget and activation.
o Calls done: ?action=(login/register/forgot/activate)&type=(artist/user/password/username)
· Torrents.php
o Handles rating, fetching and downloading of files.
o Multiple calls
· Users.php
o Handles the calls to user settings, account and profile.
· Who.php
o Handles the backend user search system
· X00nIndex.php
o Original call for the home of the site.
