web/README

   1 ==============
   2 AUR Web Interface
   3 ==============
   4
   5 Terms and Definitions:
   6 ================
   7 AUR - Arch User Repository
   8         Repository made up of a collection of build scripts that are
   9         created and submitted by the Arch community.
  10
  11 TU - Trusted User
  12         A user that can add binary packages to the [community]
  13         repository and administer AUR.
  14
  15 [unsupported]
  16         The collection of package build files hosted via the AUR website.
  17
  18 File Hierachy
  19 =========
  20
  21 Directory Layout:
  22 -------------------
  23 ./html                  - DocumentRoot for AUR, where the PHP scripts live.
  24 ./html/css              - CSS for AUR appearance
  25 ./html/css/navbar       - CSS for Arch navigation bar appearance
  26 ./html/images           - Any AUR images live here.
  27 ./lib                   - Supporting PHP include files. Access denied to Apache.
  28 ./locale
  29 ./template              - Where most of the html markup resides and minimal
  30                         amount of PHP scripting.
  31 ./template/stats
  32
  33 ./html Files:
  34 -------------
  35 account.php -
  36         PHP script to handle registering for a new account.  It prompts
  37         the visitor for account information: desired username, E-mail,
  38         password, real name, IRC nick, and default language. The info is
  39         recorded in the Users table.
  40
  41         A logged-in user can change any of their own account information. If a
  42         TU or Developer is logged into the system, they can search for and
  43         edit accounts. A TU can change an account to a TU or User account. A
  44         Developer can also change an account to the Developer type. TUs and
  45         Developers are able to suspend accounts. If an account is suspended,
  46         all packages are orphaned (the MaintainerUID field in the Packages
  47         table is set to NULL).
  48
  49 addvote.php -
  50         A form to submit proposals relating to the AUR. Only accessible to TUs
  51         and Developers. Can be used to vote on a potential new TU, or any
  52         other proposal that needs a vote. Length of the vote can be specified.
  53
  54 index.php -
  55         Main page for the AUR. Provides links to all other pages in the AUR.
  56         Gives a brief synopsis of what the AUR is and where to go for more
  57         information.
  58
  59 logout.php -
  60         Logs out a logged-in user. Clears the session id from the Sessions
  61         table and unsets the cookie.
  62
  63 packages.php -
  64         Page used to search the package database. Supports searching by name,
  65         category, maintainer, popularity, etc. Also provides the ability to go
  66         to a package page which has specific information for that package.
  67         A specific package page includes the name, description, votes, etc.
  68         As well as the ability to perform actions on the packages, such as
  69         flagging or leaving a comment on the package.
  70
  71 passreset.php -
  72         A page for a user to enter their e-mail and receive a reset e-mail to
  73         replace the forgotten password.
  74
  75 pkgsubmit.php -
  76         Page for users to upload a new package. Only allows upload of a
  77         tarball that has been compressed with gzip. Tarball must contain the
  78         PKGBUILD, scriptlets, and any other files necessary to build the
  79         package from source. The user can select a category for the package.
  80         The page makes appropriate entries into the database for tracking the
  81         newly added source package and associated information.
  82
  83 rpc.php -
  84         A frontend for tools to obtain raw information from the AUR. Features
  85         the ability to search for a package, return information on a package,
  86         return information on multiple packages, and search for a specific
  87         package maintainer. Functionality through HTTP GET.
  88
  89 rss.php -
  90         Generates RDF Site Summary (RSS) feed with the latest packages updated
  91         in the AUR. Lists most recent 20 packages. Includes package name, link
  92         to package page, package description, time of update, source listing,
  93         maintainer name.
  94
  95 tu.php -
  96         Page only available to TUs and Developers. Shows ongoing votes for
  97         proposals and past votes for proposals. Current votes can be voted on
  98         with a "Yes" vote, "No" vote, or an "Abstain" vote. Developers and TUs
  99         can only vote once. Cannot vote on a proposal about themselves.
 100
 101 voters.php -
 102         Page only available to TUs and Developers. Shows list of users that
 103         voted for a specific package. Each username links to the user's
 104         account information page.