root / pykota / trunk / NEWS @ 1286

Revision 1286, 25.7 kB (checked in by jalet, 20 years ago)

Improved documentation

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
Line 
1# $Id$
2
3PyKota - Print Quota for CUPS
4
5(c) 2003-2004 Jerome Alet <alet@librelogiciel.com>
6This program is free software; you can redistribute it and/or modify
7it under the terms of the GNU General Public License as published by
8the Free Software Foundation; either version 2 of the License, or
9(at your option) any later version.
10
11This program is distributed in the hope that it will be useful,
12but WITHOUT ANY WARRANTY; without even the implied warranty of
13MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14GNU General Public License for more details.
15
16You should have received a copy of the GNU General Public License
17along with this program; if not, write to the Free Software
18Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
19
20============================================================
21
22PyKota NEWS :
23
24    - 1.16alpha26 :
25   
26        - Job price is now computed like this :
27       
28          SUM((NbPages * PricePerPage) + PricePerJob)
29         
30          For current printer and all the printers groups it is
31          a member of, if any.
32         
33          This may be difficult to grasp, but offers unprecedented
34          flexibility.
35         
36    - 1.16alpha25 :
37   
38        - Email address can be set at user creation time,
39          using the following syntax :
40         
41            $ edpykota --add username/email@yourdomain.com
42       
43    - 1.16alpha24 :
44   
45        - CGI script now can show the printing history.
46       
47        - Bug wrt number of copies should be fixed.
48       
49        - Major code refactoring => It is now possible to
50          automatically add printers on first print.
51       
52    - 1.16alpha23 :
53   
54        - Fixed potential accuracy problem if a user printed on
55          several printers at the very same time.
56       
57    - 1.16alpha22 :
58   
59        - edpykota now allows adding printers to printer groups
60       
61    - 1.16alpha21 :
62   
63        - Allows the dot in user and printer names.
64       
65        - Printer groups are now cached too.
66       
67    - 1.16alpha20 :
68   
69        - Fixed several small bugs with the help of PyChecker.
70       
71    - 1.16alpha19 :
72     
73        - Fixed a bug in PostgreSQL backend's code.
74       
75    - 1.16alpha18 :
76   
77        - Initial code for printer groups support. Printer groups have
78          to be added with external tools like psql or gq for example.
79          Printer groups seems to work fine with users. Untested with user
80          groups for now.
81
82        - Several minor visual problems fixed in reports.
83       
84        - Fixed a bug in LDAP date handling.
85       
86        - Fix for LDAP problem with some combination of OpenLDAP + Python-LDAP
87          + some particular settings.
88         
89        - mailandpopup.sh shell script added. See sample configuration file
90          for details.
91       
92        - Several environment variables are now exported when executing
93          external commands (accounters, requesters, mailers) :
94           
95            PYKOTAUSERNAME => user who is printing
96            PYKOTAPRINTERNAME => printer on which the job is being sent
97            PYKOTATITLE => Job's title
98            PYKOTAFILENAME => Job's filename
99            PYKOTACOPIES => number of copies asked
100            PYKOTAOPTIONS => print command options (-o with CUPS)
101         
102    - 1.16alpha17 :
103   
104        - Added portugues translation.
105       
106        - Major code refactoring in accounters.
107       
108    - 1.16alpha16 :
109   
110        - Code refactoring, and addition of a real HTML reporter, to
111          have nice looking and useful web based reports (in the future).
112       
113        - Added utolower configuration option to convert all usernames
114          to lowercase during printing.
115         
116    - 1.15alpha15 :
117   
118        - Now includes the papwaitprinter.sh shell script to wait for
119          AppleTalk enabled printers.
120         
121    - 1.16alpha14 :
122   
123        - Now printing on a printer not defined in the Quota Storage,
124          results in the job being cancelled or stopped, depending
125          on the printing system.
126         
127    - 1.16alpha13 :
128   
129        - Small bugfix wrt Python v2.1
130       
131        - If username is an empty string, user root is assumed.
132       
133        - 'postgresql' is not recognized anymore as a storage backend,
134          you have to use 'pgstorage' instead. 'postgresql' used to
135          be supported for compatibility with very old PyKota versions,
136          this is not the case anymore.
137         
138    - 1.16alpha12 :
139   
140        - Job price added to job history, to keep accounting correct
141          if a printer price per page or per job is modified and the
142          history is not reset : the history would have given a false
143          amount of money charged before the printer's prices were
144          modified, this addition solves the problem.
145         
146    - 1.16alpha11 :
147   
148        - Some preliminary modifications to the database structure for
149          PostgreSQL and OpenLDAP. A script to upgrade a PostgreSQL
150          database is now provided. LDAP attributes now support
151          eq, pres and sub indexes.
152         
153        - Job history now contains additional informations : 
154          number of copies, filename, title and print options.
155         
156    - 1.16alpha10 :
157       
158        - Some modifications done to external policy handling.
159          See sample configuration file for details.
160   
161        - Spanish translation added.
162       
163    - 1.16alpha9 :
164   
165        - mailto can be set to external(...) to warn users above
166          quota with any command of your choice (e.g. linpopup).
167          Several parameters are available, see sample configuration
168          file for details.
169         
170    - 1.16alpha8 :
171   
172        - Now cupspykota transmits SIGTERMS to the original 
173          backend when the user deletes a job being processed.
174         
175        - The documentation is now licensed under the terms of the
176          GNU GPL too.
177         
178    - 1.16alpha7 :
179   
180        - The CUPS backend is now fully functionnal (it seems).
181       
182        - From now on, the use of the pykota filter with CUPS
183          is deprecated. The pykota filter still has to be
184          used with LPRng though.
185       
186    - 1.16alpha6 :
187   
188        - Bug fixed : when edpykota was used to add a printer
189          with no user or group name, a bad user/group name "*" was
190          added to the database.
191         
192    - 1.16alpha5 :
193   
194        - New CUPS backend supports device enumeration !
195          This means that NO manual CUPS configuration has to
196          be done. All can now be done from CUPS web interface.
197       
198    - 1.16alpha4 :
199   
200        - New CUPS backend added.
201       
202    - 1.16alpha3 :
203       
204        - Minimal FAQ document added.
205       
206    - 1.16alpha2 :
207   
208        - CGI script now partially supports browser's language preference
209       
210    - 1.16alpha1 :
211   
212        - Ensures that the LDAP connection is really closed at end.
213       
214        - More complete error messages in case of LDAP operation failure.
215       
216    - 1.15 :
217     
218        - Documentation improved.
219       
220    - 1.15beta :
221   
222        - Command line tools now accept multiple printer
223          names or wildcards, separated with commas.
224         
225    - 1.15alpha9 :
226   
227        - External policy can be used to auto-add unknown users
228          and any other interesting things you may want to do.
229          WARNING : You can't auto-add printers for now.
230          They have to be created manually before.
231          Look at sample configuration file for examples.
232         
233    - 1.15alpha8 :
234   
235        - Job history can be disabled if needed.
236          This feature may be useful for people who use the LDAP
237          backend and don't want their LDAP tree to grow out of
238          control.
239       
240    - 1.15alpha7 :
241   
242        - More work done on caching wrt groups.
243       
244    - 1.15alpha6 :
245   
246        - Performance bottleneck with LDAP solved.
247       
248    - 1.15alpha5 :
249   
250        - Caching mechanism for all database queries.
251
252    - 1.15alpha4 :
253   
254        - Problem with Python 2.3 fixed. Needs some definitive
255          modification.
256         
257    - 1.15alpha3 :
258   
259        - CGI script now tries to restrict view when the
260          REMOTE_USER environment variable is set. This allows
261          people to protect its use with .htaccess files.
262          When unprotected, or if REMOTE_USER is 'root', then
263          unrestricted access is granted.
264          NB : REMOTE_USER is automatically set by the web server
265          (e.g. Apache) when a page with restricted access is viewed.
266         
267    - 1.15alpha2 :
268   
269        - Better detection of LPRng.
270       
271        - Outputs a warning if printing system is unknown.
272       
273    - 1.15alpha1 :
274   
275        - Bug fix in SQL code.
276       
277    - 1.14 :
278   
279        - The PostgreSQL database connection is now always closed before
280          exit. The LDAP database connection too, but it didn't suffer
281          from the problem anyway, AFAICT.
282       
283    - 1.14beta2 :
284   
285        - An LDAP-specific configuration field was introduced, usermail.
286          Use it to specify which LDAP attribute contains a valid email
287          address for the user. See sample configuration file for
288          details.
289       
290    - 1.14beta :
291   
292        - Two new LDAP-specific configuration fields were introduced,
293          newuser and newgroup. Use them to specify if you want to add
294          quota information to existing entries or elsewhere.
295          See sample configuration file for details.
296         
297    - 1.14alpha9 :
298   
299        - Documentation improved.
300       
301        - pykotme now also prints the user's account balance value
302          if the user is registered in the Quota Storage and his
303          limiting factor is "balance".
304         
305    - 1.14alpha8 :
306   
307        - bin/waitprinter.sh is now included to wait for
308          SNMP enabled printers to be idle again before
309          asking for their internal page counter.
310          See sample configuration file for details.
311         
312    - 1.14alpha7 :
313   
314        - edpykota now doesn't check if the user/group is above
315          quota. The check is only done at print time. This
316          prevents the sending of email messages when creating
317          user quotas if quota is already reached at creation
318          time.
319         
320    - 1.14alpha6 :
321   
322        - Configuration file split and moved to /etc/pykota/pykota.conf
323          and /etc/pykota/pykotadmin.conf to prevent simple users to
324          have Read/Write access to the Quota Database.
325          Don't forget to :
326         
327                $ chmod 640 /etc/pykota/pykotadmin.conf
328               
329        - storageuser and storageuserpw configuration fields reintroduced
330          for the same reason.
331         
332        - Code cleaning for future implementation of email addresses
333          support in the PostgreSQL and LDAP backends.
334         
335    - 1.14alpha5 :
336       
337        - Big bug fixed when changing the prices for a printer
338       
339    - 1.14alpha4 :
340   
341        - When adding an user, the user itself and its account balance
342          are now added in the same LDAP entry. Before they were added
343          as two different LDAP entries.
344         
345    - 1.14alpha3 :
346   
347        - Email field added to PostgreSQL database. An upgrade script
348          is included in initscripts/postgresql.
349       
350    - 1.14alpha2 :
351   
352        - Typo fixed when using the --prototype option to edpykota
353       
354    - 1.14alpha1 :
355   
356        - Poor man's treshold included : users with a low account
357          balance (below 1.0 by default, configurable) are sent
358          a warning message.
359         
360        - All warning messages to users are now configurable. 
361          NB : Warning messages to the administrator are not.
362       
363    - 1.13 :
364   
365        - Some small fixes wrt group handling.
366       
367        - The whole module code was passed through PyChecker and
368          several small code inconsistencies were fixed,
369          as well as a bug in the groups code.
370         
371    - 1.13alpha1 :
372   
373        - Bug fix wrt LDAP.
374       
375    - 1.12 :
376   
377        - More complete test added in edpykota.
378       
379    - 1.12alpha2 :
380   
381        - The previous bug fix was incomplete. This is corrected.
382       
383    - 1.12alpha1 :
384   
385        - Small bug fix.
386       
387    - 1.11 :
388   
389        - Now includes the pykotme command line tool, to produce
390          printing quotes for users.
391         
392    - 1.10 :
393   
394        - Bug fixed wrt quota reports when print limiting is by
395          account balance.
396         
397    - 1.09 :
398   
399        - Translations finalized.
400       
401        - Manpages updated.
402       
403        - Installation documentation improved wrt LDAP support.
404       
405    - 1.09beta2 :
406   
407        - The CGI script for quota reports works again, and
408          is much more powerful.
409       
410    - 1.09beta :
411   
412        - edpykota finalized
413       
414    - 1.09alpha2 :
415   
416        - LDAP schema modified a bit. Please upgrade.
417       
418        - LDAP backend works !
419       
420        - repykota and warnpykota allow the root user to pass
421          users or groups names on the command line. Users
422          and groups names may contain wildcards.
423         
424        - repykota and warnpykota only reports or warns the
425          current user when launched by non-root users.
426         
427        - Minor bug fixes. 
428   
429    - 1.09alpha1 :
430   
431        - More work on LDAP storage backend. Many options
432          were added to /etc/pykota.conf to give some
433          hints to the LDAP storage backend.
434         
435        - Severe database access optimizations were done by
436          rewriting most of the Quota Storage backends drivers.
437     
438    - 1.08 :
439   
440        - Major bug fix wrt LPRng support for remote jobs.
441       
442        - Major bug fix wrt increase/decrease account balances.
443       
444    - 1.08alpha8 :
445   
446        - Code refactoring.
447       
448        - A single user/password pair is used to connect
449          to the database backend. The storageuser configuration
450          field, and its associated passwords storageuserpw, are
451          not used anymore.
452         
453        - You can now set PyKota in debug mode, see sample configuration 
454          file for details.
455          WARNING : only Quota Storage backend queries are logged in
456          debug mode, for now.
457       
458    - 1.08alpha7 :
459   
460        - Very latest LDAP schema.
461       
462        - Code enhancement wrt easy pluggability of PyKota attributes
463          and object classes into an existing LDAP directory.
464       
465    - 1.08alpha6 :
466   
467        - Minor bug corrections
468       
469        - More work on LDAP : new schema
470       
471    - 1.08alpha5 :
472   
473        - More good work on LDAP storage.
474          repykota now works reasonably well with the sample LDAP directory.
475       
476    - 1.08alpha4 :
477   
478        - LDAP schema included.
479          THIS IS JUST FOR PEOPLE TO DISCUSS ABOUT THIS.
480          LDAP SUPPORT DOESN'T WORK YET, AND THE SCHEMA
481          MAY CHANGE IN THE FUTURE. PLEASE TELL US
482          WHAT YOU THINK ABOUT THIS SCHEMA ON THE
483          MAILING LIST.
484         
485    - 1.08alpha3 :
486   
487        - External accounting methods were partly rewritten :
488         
489          - No more "broken pipe" should happen.
490         
491          - They now take care of the number of copies
492            This may be unneeded though, if the postscript
493            file already does this, because this would
494            overcharge users (number of copies counted
495            two times). NEEDS MORE TESTING.
496           
497          - The sample configuration file now contains 
498            an external accounting method example which should
499            work with all DSC compliant Postscript files.
500           
501        - Some small bugs were fixed.   
502       
503    - 1.08alpha2 :
504   
505        - Now works with net-snmp v5.0 and above.
506          It already worked, but the sample configuration
507          file didn't contain appropriate values...
508       
509    - 1.07 : Release of the Shame !
510   
511        - The external accounting methods driver was left out of
512          the CVS tree. Nobody could use it since it wasn't included !
513         
514    - 1.06 :
515   
516        - Severe bug fixed : if you had a printer in
517          power saving state which couldn't answer immediately,
518          a bug was triggered.
519          It was caused by a bad copy/paste which
520          forgot to import a Python module at run time.
521         
522    - 1.05 :
523   
524        - External accounters are finally available !
525          This means that you can plug any page accounting
526          method you like by setting the appropriate
527          'accounter' field in /etc/pykota.conf
528          See the sample conf/pykota.conf.sample to
529          learn how to do.
530         
531          NB : Both 'external' and 'stupid' accounting methods
532               account a job size just before *this* job is
533               sent to the printer.
534               The original 'querying' method accounts a job
535               size just before *the next* job is sent to
536               the printer.
537       
538    - 1.05alpha3 :
539   
540        - A 'stupid' and unreliable accounting method was
541          implemented to serve as an example on how to
542          do this sort of things. This method only counts
543          the 'showpage' statements in the input data.
544          See sample configuration file for details.
545          Pluggable accounting methods work, but I advise
546          you TO NOT USE THIS ONE WHICH IS JUST AN EXAMPLE.
547          It is not reliable enough to be used.
548          Use the 'querying' accounting method instead.
549         
550    - 1.05alpha2 :
551   
552        - Pluggable accounting methods.
553       
554        - Better error handling.
555       
556    - 1.05alpha1 :
557   
558        - SECURITY file added to help improve PyKota's security.
559       
560        - Extracting the printer's internal page counter is now
561          tried several times, waiting several seconds between
562          two tries. This lets the time to warm up for some printers
563          which don't answer when they are sleeping (my Apple
564          LaserWriter 16/600 PS is in this case, maybe others too)
565         
566        - Small display bug fixed in repykota
567         
568    - 1.04 :
569   
570        - Default print policy for users/groups unknown from
571          the print quota system is now DENY instead of ALLOW,
572          since ALLOW can generate inaccurate results
573          (incorrect job sizes charged to the wrong persons)
574         
575        - LPRng support works !
576       
577        - A bug was introduced some time ago wrt printers' default
578          policy for unknown users. It is now corrected.
579       
580        - repykota now displays prices per job and per page for each
581          printer, if they are defined.
582         
583        - Minor display bug fixed in repykota.
584       
585        - Problem when running repykota with an empty database was fixed.
586       
587    - 1.03 :
588   
589        - Upgrade script included for earlier versions.
590          Please look inside the initscripts subdirectory.
591          THE DATABASE SCHEMA HAS CHANGED, PLEASE UPGRADE.
592         
593        - repykota now reports account balances too.
594       
595        - PyKota now has a nice logo, see the logos
596          subdirectory.
597       
598        - Manual pages were finally updated.
599       
600        - Group quotas seem to work now !
601       
602        - The new database schema allows to keep an history of all
603          jobs as well as charge users per page and/or per job,
604          and track users' account balance.
605         
606        - edpykota now accepts much more command line options to 
607          use the new functionnalities. See edpykota --help for
608          details.
609         
610        - The installation script now allows to install the sample
611          configuration file during first installation.
612         
613        - More group quota code works, but still not finished. 
614       
615        - The CGI script displays a link to PyKota's website.
616       
617        - The job history is now kept, this will allow per-period
618          reports in the future.
619         
620        - After having modified the quota for an user with edpykota,
621          a quota check is done to eventually warn the user/admin about
622          a quota which is too low to print.
623         
624        - A workaround is provided for HP Printers : their internal
625          page counter is only saved to NVRAM in a 10 increment, so
626          if you switch them off and then on, the reported page counter
627          may be lower than the real number of pages printed.
628          See http://web.mit.edu/source/third/lprng/doc/LPRng-HOWTO-15.html
629          We unconditionnally set the last job's page count to
630          abs(int((10 - abs(lastcounter(snmp) - lastcounter(storage)) / 2))
631          in this case.
632          For a more accurate accounting, never switch your HP printers
633          off.
634         
635        - A fix is provided for printers which only have a volatile 
636          page counter (reset to 0 every time you switch the printer on)
637          This should allow PyKota to work reasonably fine with HP Laserjet
638          4L/5L/6L, not perfect, but better than nothing.
639          See http://web.mit.edu/source/third/lprng/doc/LPRng-HOWTO-15.html
640          For a more accurate accounting, never switch your HP printers
641          off. This is untested, please report any problem.
642         
643        - A bug was fixed when edpykota --add was used with users who already
644          had a quota on the specified printer.
645         
646        - A small display bug in repykota was introduced in preliminary
647          1.03 versions, and fixed later on.
648         
649        - Some minor bugs which happened in rare situations were fixed.
650       
651        - Support for AppleTalk printers was added, see sample configuration
652          file for details.
653         
654        - Users and group printing can now be controlled (limited) either by 
655          print quota or by account balance.
656       
657    - 1.02 :
658   
659        - The installation script now checks for software availability
660          and in case a software is missing asks the user if he
661          wants to continue with the installation or abort it.
662         
663        - The configuration file pykota.conf is now expected to be
664          found in /etc instead of in /etc/cups
665          The installation script prompts the user to see if he
666          wants to move an old configuration file to the new location
667          if needed.
668         
669        - Improved documentation.
670       
671        - You can now set the tcp/ip port on which the Quota Storage
672          Server is listening, see sample configuration file for details.
673       
674        - Better general error handling.
675       
676        - Upgrade script for pre 1.01 PostgreSQL database schema is now
677          included as well.
678       
679    - 1.01 :
680   
681        - The configuration file now accepts an option   
682          to choose the recipient(s) of the email messages :
683         
684            - DevNull means no one will receive them.
685            - User means only the user will receive them.
686            - Admin means only the admin will receive them.
687            - Both means the User and the Admin will receive them.
688           
689        - The configuration file now uses hard-coded default values
690          when an option is not set. See sample configuration file
691          for details.
692         
693        - Manual pages are included since 1.00, but I forgot to   
694          add this information to this file.
695         
696        - Redistribution terms for the official package have 
697          softened and are now fully GPL compatible :
698          unrestricted modification is now allowed even for
699          the version number.
700         
701    - 1.00 :
702   
703        - edpykota now accepts a --noquota option. This
704          disable quota checking while still doing page
705          accounting. This is really useful for people
706          who don't want to limit their users but want
707          to know how much pages they print.
708         
709        - Some untested scripts were added to retrieve
710          the life time page counter of non-SNMP printers.
711         
712        - Every directory now has a specific README file. 
713       
714    - 0.99 :
715   
716        - Under some circumstances while the user wasn't allowed
717          to print, he didn't receive any email message. It is
718          now fixed.
719         
720        - When an user wasn't allowed to print, the quota for
721          the previous user wasn't updated. This is now fixed.
722         
723    - 0.98 :
724   
725        - Correctly handle the case where the printer is switched off.
726       
727        - Small bug wrt syslog fixed.
728       
729    - 0.97 :
730   
731        - edpykota accepts wildcards on its command line for users/groups too
732          if the --add option is not set, e.g. :
733         
734              $ edpykota --printer lp --softlimit 50 --hardlimit 100 "jer*"
735             
736        - If no user name is passed at all, then a default wildcard of "*"
737          which means apply the command on ALL users for this printer is used.
738         
739        - Small bug fixes.
740       
741    - 0.96 :
742
743        - Options requester, policy, admin, adminmail and gracedelay can now
744          be set either globally or per printer. The printer option has
745          priority if both are defined.
746
747        - More powerful configuration parser.
748       
749        - If all options are defined globally, there's no need to
750          define a section for each printer in the configuration
751          file anymore. Just define a [global] section and it's ok.
752
753    - 0.95 :
754
755        - External requesters for printers finally added.
756
757        - Full internationalization (english and french are supported)
758 
759        - More complete quota usage report
760
761        - CGI script to access to the quota usage report
762
763        - Several bugs fixed.
764
765
766    - 0.9 :
767
768        - First public version
Note: See TracBrowser for help on using the browser.