root / pykota / trunk / docs / repykota.sgml @ 2990

<!-- $Id$ -->

<chapter>
  <title id="repykota">Create print quota usage reports with repykota</title>
  <para>Last modified on $Date$</para>
  
  <para>
    To account for print usage is good, however there must be a way to easily
    query the print quota database and generate
    reports describing current usage for every user on every printer.
  </para>
  
  <sect1>
    <title>Command line based Print Quota reports</title>
    
    <para>
      PyKota features a quota report generator, named <command>repykota</command>,
      with which you can print the current state of the quota database.
    </para>
    
    <para>
      <command>repykota</command> behaves differently when it is launched by a
      <application>PyKota</application> administrator, compared to when it is launched by a normal user.
    </para>  
    
    <para>
      In the first case, the print quota report will contain current account balance, 
      soft and hard limits, number of pages printed since last reset, total number
      of pages printed, total paid, for possibly all users or all groups, depending
      on command line options.
    </para>
    
    <para>
      In the second case, i.e. when <command>repykota</command> is launched by
      a normal user, the user will only be allowed to see informations about himself or 
      the groups he his a member of.
    </para>
  
    <para>
      Any user can limit the report to only one or more printers, by specifying the
      <literal>-P</literal> or <literal>--printer</literal> command line option, 
      followed by one or more printer name or wildcard. If more than one printer name
      or wildcard is used, they must be separated by commas.
    </para>
    
    <para>
      Launching <command>repykota</command> with no arguments will generate
      a complete print quota report, depending on what you are allowed to see.
    </para>
    
    <para>
      Use the <literal>--help</literal> command line argument to learn what are
      the different command line options available.
    </para>
    
    <sect2>
      <title>Reference</title>
      <para>
        <cmdsynopsis>
          <command>repykota</command>
          <group choice="opt"><arg>-v</arg><arg>--version</arg></group>
          <group choice="opt"><arg>-h</arg><arg>--help</arg></group>
          <group choice="opt"><arg>-u</arg><arg>--users</arg></group>
          <group choice="opt"><arg>-g</arg><arg>--groups</arg></group>
          <group choice="opt">
            <arg>-P <replaceable>printername</replaceable></arg>
            <arg>--printer <replaceable>printername</replaceable></arg>
          </group>  
          <group choice="opt">
            <arg><replaceable>name1</replaceable></arg>
            <arg><replaceable>name2</replaceable></arg>
            <arg><replaceable>...</replaceable></arg>
            <arg><replaceable>nameN</replaceable></arg>
          </group>  
        </cmdsynopsis>
      </para>
    </sect2>
  </sect1>
  
  <sect1>
    <title>Web based Print Quota reports</title>
    
    <para>
      <application>PyKota</application> also features a CGI script to remotely access
      to print quota reports with a web browser, it is called <command>printquota.cgi</command>
      and you can put it in your web server's <filename>cgi-bin</filename> directory if a web server is installed on
      any machine on which <application>PyKota</application> is also installed and configured
      correctly.
    </para>
    
    <para>
      You may also want to copy the <acronym>CSS</acronym> stylesheets which are present in the
      <filename>stylesheets/</filename> directory to your web server's <literal>DocumentRoot</literal>
      (e.g. <filename>/var/lib/www</filename>) so that the CGI script can find them to present
      a nicer web interface.
    </para>
    
    <para>
      You can find <command>printquota.cgi</command> in the <filename>pykota/cgi-bin</filename>
      directory. Here's how to install it, provided that your web server's <filename>cgi-bin</filename>
      directory is <filename>/usr/lib/cgi-bin</filename> :
<screen>      
port50-2:/home/jerome/pykota$ cp cgi-bin/printquota.cgi /usr/lib/cgi-bin
port50-2:/home/jerome/pykota$ chmod 755 /usr/lib/cgi-bin/printquota.cgi
</screen>

      <note>
        <title>Note</title>
        <para>
          Please ensure that the user your web server is run as, for example <literal>www-data</literal> under
          Debian, is allowed to read <filename>~pykota/pykota.conf</filename> but for security reasons you
          must ensure that this user <emphasis>is not</emphasis> allowed to read <filename>~pykota/pykotadmin.conf</filename>
        </para>
      </note>  
    </para>
    
    <para>
      If you install the CGI script as described above, any user will be allowed to view the complete print
      quota report, for all users, groups and printers. This is then a different behavior compared to when
      a normal user wants a print quota report from the command line through <command>repykota</command>.
      If you find this disturbing, then the best is to ask for user authentication whenever the <command>printquota.cgi</command>
      CGI script is accessed. This CGI script will then automatically behave as expected, showing in the print quota
      report only what the authenticated user is allowed to see, just like when he launches <command>repykota</command>
      from the command line. As a special case, if the user authenticates using the <literal>root</literal> username,
      then there's no restriction on what may appear on the print quota report.
    </para>
    
    <para>
      To automatically ask for an authentication dialog whenever the CGI script is accessed, you have to configure
      your web server to do so. If your webserver is <ulink url="http://httpd.apache.org"><application>Apache</application></ulink>, then it's relatively easy. First you have to put 
      <command>printquota.cgi</command> in its own subdirectory below your web server's <filename>cgi-bin</filename>
      directory, for example in <filename>cgi-bin/PyKota/</filename>. Then use the <command>htpasswd</command>
      command line tool to create a file which contains usernames and passwords for all your users allowed to see
      the print quota report from a web browser, and put this file outside of the directories served by <application>Apache</application>
      so that nobody could retrieve it. Finally create a file named <filename>.htaccess</filename> in
      <filename>cgi-bin/PyKota/</filename> with appropriate content in it. This file should tell <application>Apache</application> to automatically ask
      for an authentication whenever something from this directory is accessed, and to use the password file previously
      created to match usernames and passwords.
      You may also have to tweak <application>Apache</application>'s default configuration to allow the
      authentication mechanism.
    </para>
    
    <para>
      The detailed procedure to do all this is out of the scope of the present document, please refer to
      <application>Apache</application>'s <ulink url="http://httpd.apache.org/docs-project/">documentation</ulink> 
      for all the gory details.
    </para>
  </sect1>
</chapter>