1 # <a name="TWiki Source Code Packages"></a><a name=" TWiki Source Code Packages"></a> TWiki Source Code Packages
3 %X% This documentation is automatically generated from the `pod`, so it always matches the running code
7 <li><a href="#TWiki::_AccessControlException"> TWiki::AccessControlException </a></li>
8 <li><a href="#TWiki::Access"> TWiki::Access </a></li>
9 <li><a href="#TWiki::Attach"> TWiki::Attach </a></li>
10 <li><a href="#TWiki::Attrs"> TWiki::Attrs </a></li>
11 <li><a href="#TWiki::Client::_ApacheLogin"> TWiki::Client::ApacheLogin </a></li>
12 <li><a href="#TWiki::Client"> TWiki::Client </a></li>
13 <li><a href="#TWiki::Client::_TemplateLogin"> TWiki::Client::TemplateLogin </a></li>
14 <li><a href="#TWiki::Compatibility"> TWiki::Compatibility </a></li>
15 <li><a href="#TWiki"> TWiki </a></li>
16 <li><a href="#TWiki::Form"> TWiki::Form </a></li>
17 <li><a href="#TWiki::Func"> TWiki::Func </a></li>
18 <li><a href="#TWiki::_I18N"> TWiki::I18N </a></li>
19 <li><a href="#TWiki::_I18N::Extract"> TWiki::I18N::Extract </a></li>
20 <li><a href="#TWiki::If"> TWiki::If </a></li>
21 <li><a href="#TWiki::Merge"> TWiki::Merge </a></li>
22 <li><a href="#TWiki::Merge"> TWiki::Merge </a></li>
23 <li><a href="#TWiki::Meta"> TWiki::Meta </a></li>
24 <li><a href="#TWiki::Net"> TWiki::Net </a></li>
25 <li><a href="#TWiki::_OopsException"> TWiki::OopsException </a></li>
26 <li><a href="#"> </a></li>
27 <li><a href="#TWiki::Plugins"> TWiki::Plugins </a></li>
28 <li><a href="#TWiki::Plurals"> TWiki::Plurals </a></li>
29 <li><a href="#TWiki::Prefs"> TWiki::Prefs </a></li>
30 <li><a href="#TWiki::Prefs::Parser"> TWiki::Prefs::Parser </a></li>
31 <li><a href="#TWiki::Prefs::_PrefsCache"> TWiki::Prefs::PrefsCache </a></li>
32 <li><a href="#TWiki::Render"> TWiki::Render </a></li>
33 <li><a href="#TWiki::Sandbox"> TWiki::Sandbox </a></li>
34 <li><a href="#TWiki::Search"> TWiki::Search </a></li>
35 <li><a href="#TWiki::Store"> TWiki::Store </a></li>
36 <li><a href="#TWiki::Store::_RcsFile"> TWiki::Store::RcsFile </a></li>
37 <li><a href="#TWiki::Store::_RcsLite"> TWiki::Store::RcsLite </a></li>
38 <li><a href="#File format"> File format</a></li>
39 <li><a href="#TWiki::Store::_RcsWrap"> TWiki::Store::RcsWrap </a></li>
40 <li><a href="#TWiki::Templates"> TWiki::Templates </a></li>
41 <li><a href="#TWiki::Time"> TWiki::Time </a></li>
42 <li><a href="#TWiki::UI::_ChangeForm"> TWiki::UI::ChangeForm </a></li>
43 <li><a href="#TWiki::UI"> TWiki::UI </a></li>
44 <li><a href="#TWiki::UI::Edit"> TWiki::UI::Edit </a></li>
45 <li><a href="#TWiki::UI::Manage"> TWiki::UI::Manage </a></li>
46 <li><a href="#TWiki::UI::Oops"> TWiki::UI::Oops </a></li>
47 <li><a href="#TWiki::UI::RDiff"> TWiki::UI::RDiff </a></li>
48 <li><a href="#TWiki::UI::Register"> TWiki::UI::Register </a></li>
49 <li><a href="#TWiki::UI::Rest"> TWiki::UI::Rest </a></li>
50 <li><a href="#TWiki::UI::Save"> TWiki::UI::Save </a></li>
51 <li><a href="#TWiki::UI::Search"> TWiki::UI::Search </a></li>
52 <li><a href="#TWiki::UI::Statistics"> TWiki::UI::Statistics </a></li>
53 <li><a href="#TWiki::UI::Upload"> TWiki::UI::Upload </a></li>
54 <li><a href="#TWiki::UI::View"> TWiki::UI::View </a></li>
55 <li><a href="#TWiki::User"> TWiki::User </a></li>
56 <li><a href="#TWiki::Users::_ApacheHtpasswdUse"> TWiki::Users::ApacheHtpasswdUser </a></li>
57 <li><a href="#TWiki::Users"> TWiki::Users </a></li>
58 <li><a href="#TWiki::Users::Password"> TWiki::Users::Password </a></li>
62 ## <a name="TWiki::_AccessControlException"></a> [[TWiki::AccessControlException|Main/TWikiAccessControlExceptionDotPm]]
64 Exception used raise an access control violation.
66 This package doesn't smell
68 ## <a name="TWiki::Access"></a> [[TWiki::Access|Main/TWikiAccessDotPm]]
70 A singleton object of this class manages the access control database.
72 This package has smell factor of **1**
74 ## <a name="TWiki::Attach"></a> [[TWiki::Attach|Main/TWikiAttachDotPm]]
76 A singleton object of this class is used to deal with attachments to topics.
78 This package has smell factor of **2**
80 ## <a name="TWiki::Attrs"></a> [[TWiki::Attrs|Main/TWikiAttrsDotPm]]
82 Class of attribute sets, designed for parsing and storing attribute values from a TWiki tag e.g. `%TAG{fred='bad' "sad" joe="mad"}%`
84 An attribute set is a map containing an entry for each parameter. The default parameter (unnamed quoted string) is named `_DEFAULT` in the map.
86 Attributes declared later in the string will override those of the same name defined earlier. The one exception to this is the \_DEFAULT key, where the _first_ instance of a setting is always taken.
88 As well as standard TWiki syntax (parameter values double-quoted) it also parses single-quoted values, unquoted spaceless values, spaces around the =, and commas as well as spaces separating values, though none of these alternatives is advertised in documentation and the extended syntax can be turned off by passing the 'strict' parameter to `new`.
90 This class replaces the old TWiki::extractNameValuePair and TWiki::extractParameters.
92 This package doesn't smell
94 ## <a name="TWiki::Client::_ApacheLogin"></a> [[TWiki::Client::ApacheLogin|Main/TWikiClientApacheLoginDotPm]]
96 This is login manager that you can specify in the security setup section of [configure](http://www.dementia.org/twiki//configure). It instructs TWiki to cooperate with your web server (typically Apache) to require authentication information (username & password) from users. It requires that you configure your web server to demand authentication for scripts named "login" and anything ending in "auth". The latter should be symlinks to existing scripts; e.g., `viewauth -> view`, `editauth -> edit`, and so on.
98 See also [[TWikiUserAuthentication]].
100 Subclass of TWiki::Client; see that class for documentation of the methods of this class.
102 This package doesn't smell
104 ## <a name="TWiki::Client"></a> [[TWiki::Client|Main/TWikiClientDotPm]]
106 The package is also a Factory for login managers and also the base class for all login managers.
108 On it's own, an object of this class is used when you specify 'none' in the security setup section of [configure](http://www.dementia.org/twiki//configure). When it is used, logins are not supported. If you want to authenticate users then you should consider [[TemplateLogin]] or [[ApacheLogin]], which are subclasses of this class.
110 If you are building a new login manager, then you should write a new subclass of this class, implementing the methods marked as **VIRTUAL**. There are already examples in the `lib/TWiki/Client` directory.
112 This package has smell factor of **3**
114 ## <a name="TWiki::Client::_TemplateLogin"></a> [[TWiki::Client::TemplateLogin|Main/TWikiClientTemplateLoginDotPm]]
116 This is a login manager that you can specify in the security setup section of [configure](http://www.dementia.org/twiki//configure). It provides users with a template-based form to enter usernames and passwords, and works with the [[PasswordManager]] that you specify to verify those passwords.
118 Subclass of TWiki::Client; see that class for documentation of the methods of this class.
120 This package has smell factor of **2**
122 ## <a name="TWiki::Compatibility"></a> [[TWiki::Compatibility|Main/TWikiCompatibilityDotPm]]
124 Support for compatibility with old TWiki versions. Packaged separately because 99.999999% of the time this won't be needed.
128 sub \_upgradeCategoryItem \{ my ( $catitems, $ctext ) = @\_; my $catname = ''; my $scatname = ''; my $catmodifier = ''; my $catvalue = ''; my @cmd = split( /\\|/, $catitems ); my $src = ''; my $len = @cmd; if( $len < '2' ) \{ # FIXME return ( $catname, $catmodifier, $catvalue ) \} my $svalue = '';
130 my $i; my $itemsPerLine;
132 # check for [[CategoryName]]=CategoryValue parameter my $paramCmd = ''; my $cvalue = ''; # was$query->param( $cmd[1] ); if( $cvalue ) \{ $src = "$cvalue"; \} elsif( $ctext ) \{ foreach( split( /\\r?\\n/, $ctext ) ) \{ if( /$cmd[1]/ ) \{ $src = $\_; last; \} \} \}
134 if( $cmd[0] eq 'select' || $cmd[0] eq 'radio') \{ $catname = $cmd[1]; $scatname = $catname; #$scatname =~ s/[^a-zA-Z0-9]//g; my $size = $cmd[2]; for( $i = 3; $i < $len; $i++ ) \{ my $value = $cmd[$i]; $svalue = $value; if( $src =~ /$value/ ) \{ $catvalue = $svalue; \} \}
136 \} elsif( $cmd[0] eq 'checkbox' ) \{ $catname = $cmd[1]; $scatname = $catname; #$scatname =~ s/[^a-zA-Z0-9]//g; if( $cmd[2] eq 'true' || $cmd[2] eq '1' ) \{ $i = $len - 4; $catmodifier = 1; \} $itemsPerLine = $cmd[3]; for( $i = 4; $i < $len; $i++ ) \{ my $value = $cmd[$i]; $svalue = $value; # [[I18N]]: FIXME - need to look at this, but since it's upgrading # old forms that probably didn't use [[I18N]], it's not a high # priority. if( $src =~ /$value[^a-zA-Z0-9\\.]/ ) \{ $catvalue .= ", " if( $catvalue ); $catvalue .= $svalue; \} \}
138 \} elsif( $cmd[0] eq 'text' ) \{ $catname = $cmd[1]; $scatname = $catname; #$scatname =~ s/[^a-zA-Z0-9]//g; $src =~ /(.\*)/; if( $1 ) \{ $src = $1; \} else \{ $src = ''; \} $catvalue = $src; \}
140 return ( $catname, $catmodifier, $catvalue ) \}
142 This package has smell factor of **2**
144 ## <a name="TWiki"></a> [[TWiki|Main/TWikiDotPm]]
146 TWiki operates by creating a singleton object (known as the Session object) that acts as a point of reference for all the different modules in the system. This package is the class for this singleton, and also contains the vast bulk of the basic constants and the per- site configuration mechanisms.
148 Global variables are avoided wherever possible to avoid problems with CGI accelerators such as mod\_perl.
150 This package has smell factor of **29**
152 ## <a name="TWiki::Form"></a> [[TWiki::Form|Main/TWikiFormDotPm]]
154 Object representing a single form definition.
156 This package has smell factor of **11**
158 ## <a name="TWiki::Func"></a> [[TWiki::Func|Main/TWikiFuncDotPm]]
160 _Official list of stable TWiki functions for Plugin developers_
162 This module defines official functions that [[Plugins|TWiki/TWikiPlugins]] can use to interact with the TWiki engine and content.
164 Refer to [[EmptyPlugin]] and lib/TWiki/Plugins/EmptyPlugin.pm for a template Plugin and documentation on how to write a Plugin.
166 Plugins should **only** use functions published in this module. If you use functions in other TWiki libraries you might create a security hole and you will probably need to change your Plugin when you upgrade TWiki.
168 Deprecated functions will still work in older code, though they should _not_ be called in new Plugins and should be replaced in older Plugins as soon as possible.
170 The version of the TWiki::Func module is defined by the VERSION number of the TWiki::Plugins module, currently 1.11. This can be shown by the `%PLUGINVERSION%` variable. The 'Since' field in the function documentation refers to the VERSION number and the date that the function was addded.
172 **_Note:_** Beware! These methods should only ever be called from the context of a TWiki Plugin. They require a Plugins SESSION context to be established before they are called, and will not work if simply called from another TWiki module. For example,
175 print TWiki::Func::getSkin(),"\n";
177 will fail with `Can't call method "getSkin" on an undefined value at TWiki/Func.pm line 83`.
179 If you want to call the methods outside the context of a plugin, you can create a Plugins SESSION object. For example, the script:
182 $TWiki::Plugins::SESSION = new TWiki();
183 print TWiki::Func::getSkin(),"\n";
187 This package has smell factor of **1**
189 ## <a name="TWiki::_I18N"></a> [[TWiki::I18N|Main/TWikiI18NDotPm]]
191 Support for strings translation and language detection.
193 This package has smell factor of **1**
195 ## <a name="TWiki::_I18N::Extract"></a> [[TWiki::I18N::Extract|Main/TWikiI18NExtractDotPm]]
197 Support translatable strings extraction from TWiki topics and templates. Depends on Locale::Maketext::Extract (part of CPAN::Locale::Maketext::Lexicon).
199 This package has smell factor of **1**
201 ## <a name="TWiki::If"></a> [[TWiki::If|Main/TWikiIfDotPm]]
203 Support for the conditions in %IF\{\} statements. Basically a simple stack-based parser for infix expressions that generates a parse tree that can subsequently be evaluated.
205 This package doesn't smell
207 ## <a name="TWiki::Merge"></a> [[TWiki::Merge|Main/TWikiMerge3DotPm]]
209 Support for 3-way merging of strings. Similar to Merge.pm, except that: a) it's considers the ancestor revision of the string, and b) it works. :-P
211 This package doesn't smell
213 ## <a name="TWiki::Merge"></a> [[TWiki::Merge|Main/TWikiMergeDotPm]]
215 Support for merging strings
217 This package doesn't smell
219 ## <a name="TWiki::Meta"></a> [[TWiki::Meta|Main/TWikiMetaDotPm]]
223 A meta-data object is a hash of different types of meta-data (keyed on the type, such as 'FIELD' and 'TOPICINFO').
225 Each entry in the hash is an array, where each entry in the array contains another hash of the key=value pairs, corresponding to a single meta-datum.
227 If there may be multiple entries of the same top-level type (i.e. for FIELD and FILEATTACHMENT) then the array hash multiple entries. These types are referred to as "keyed" types. The array entries are keyed with the attribute 'name' which must be in each entry in the array.
229 For unkeyed types, the array has only one entry.
231 The module knows nothing about how meta-data is stored. That is entirely the responsibility of the Store module.
233 Meta-data objects are created by the Store engine when topics are read. They are populated using the `put` method.
235 This package has smell factor of **6**
237 ## <a name="TWiki::Net"></a> [[TWiki::Net|Main/TWikiNetDotPm]]
239 Object that brokers access to network resources.
241 This package has smell factor of **2**
243 ## <a name="TWiki::_OopsException"></a> [[TWiki::OopsException|Main/TWikiOopsExceptionDotPm]]
245 Exception used to raise a request to redirect to an Oops URL. An [[OopsException]] thrown anywhere in the code will redirect the browser to a url based on the `oops` script. `oops` requires a `template` parameter, that is the name of a template file from the `templates` directory. This file will be expanded and the parameter values passed to the exception instantiated. The result will be shown in the browser.
247 This package doesn't smell
249 ## <> \[[TWikiPluginDotPm]\[]]
251 This package has smell factor of **2**
253 ## <a name="TWiki::Plugins"></a> [[TWiki::Plugins|Main/TWikiPluginsDotPm]]
255 This module defines the singleton object that handles Plugins loading, initialization and execution.
257 This class uses Chain of Responsibility (GOF) pattern to dispatch handler calls to registered plugins.
259 This package doesn't smell
261 ## <a name="TWiki::Plurals"></a> [[TWiki::Plurals|Main/TWikiPluralsDotPm]]
263 Handle conversion of plural topic names to singular form.
265 This package has smell factor of **3**
267 ## <a name="TWiki::Prefs"></a> [[TWiki::Prefs|Main/TWikiPrefsDotPm]]
269 The Prefs class is a singleton that implements management of preferences. It uses a stack of TWiki::Prefs::PrefsCache objects to store the preferences for global, web, user and topic contexts, and provides the means to look up preferences in these.
271 Preferences from different places stack on top of each other, so there are global preferences, then site, then web (and subweb and subsubweb), then topic, included topic and so on. Each level of the stack is tagged with a type identifier.
273 The module also maintains a separate of the preferences found in every topic and web it reads. This supports the lookup of preferences for webs and topics that are not on the stack, and must not be chained in (you can't allow a user to override protections from their home topic!)
275 This package has smell factor of **1**
277 ## <a name="TWiki::Prefs::Parser"></a> [[TWiki::Prefs::Parser|Main/TWikiPrefsParserDotPm]]
279 This Prefs-internal class is used to parse \* Set and \* Local statements from arbitrary text, and extract settings from meta objects. It is used by [[TopicPrefs]] to parse preference settings from topics.
281 This class does no validation or duplicate-checking on the settings; it simply returns the recognized settings in the order it sees them in.
283 This package has smell factor of **1**
285 ## <a name="TWiki::Prefs::_PrefsCache"></a> [[TWiki::Prefs::PrefsCache|Main/TWikiPrefsPrefsCacheDotPm]]
287 The [[PrefsCache]] package holds a cache of topics that have been read in, using the [[TopicPrefs]] class. These functions manage that cache.
289 We maintain 2 hashes of values:
291 - \{locals\} Contains all locals at this level. Locals are values that only apply when the current topic is the topic where the local is defined. The variable names are decorated with the locality where they apply.
292 - \{values\} contains all sets, locals, and all values inherited from the parent level
294 As each cache level is built, the values are copied down from the parent cache level. This sounds monstrously inefficient, but in fact perl does this a lot better than doing a multi-level lookup when a value is referenced. This is especially important when many prefs lookups may be done in a session, for example when searching.
296 This package has smell factor of **1**
298 ## <a name="TWiki::Render"></a> [[TWiki::Render|Main/TWikiRenderDotPm]]
300 This module provides most of the actual HTML rendering code in TWiki.
302 This package has smell factor of **24**
304 ## <a name="TWiki::Sandbox"></a> [[TWiki::Sandbox|Main/TWikiSandboxDotPm]]
306 This object provides an interface to the outside world. All calls to system functions, or handling of file names, should be brokered by this object.
308 This package has smell factor of **3**
310 ## <a name="TWiki::Search"></a> [[TWiki::Search|Main/TWikiSearchDotPm]]
312 This module implements all the search functionality.
314 This package has smell factor of **22**
316 ## <a name="TWiki::Store"></a> [[TWiki::Store|Main/TWikiStoreDotPm]]
318 This module hosts the generic storage backend. This module provides the interface layer between the "real" store provider - which is hidden behind a handler - and the rest of the system. it is responsible for checking for topic existance, access permissions, and all the other general admin tasks that are common to all store implementations.
320 This module knows nothing about how the data is actually _stored_ - that knowledge is entirely encapsulated in the handlers.
322 The general contract for methods in the class requires that errors are signalled using exceptions. TWiki::AccessControlException is used for access control exceptions, and Error::Simple for all other types of error.
324 This package has smell factor of **17**
326 ## <a name="TWiki::Store::_RcsFile"></a> [[TWiki::Store::RcsFile|Main/TWikiStoreRcsFileDotPm]]
328 This class is PACKAGE PRIVATE to Store, and should never be used from anywhere else. Base class of implementations of stores that manipulate RCS format files.
330 The general contract of the methods on this class and its subclasses calls for errors to be signalled by Error::Simple exceptions.
332 Refer to Store.pm for models of usage.
334 This package has smell factor of **10**
336 ## <a name="TWiki::Store::_RcsLite"></a> [[TWiki::Store::RcsLite|Main/TWikiStoreRcsLiteDotPm]]
338 This package does not publish any methods. It implements the virtual methods of the [[TWiki::Store::RcsFile|Main/TWikiStoreRcsFileDotPm]] superclass.
340 Simple replacement for RCS. Doesn't support:
345 Neither of which are used (or needed) by TWiki.
347 This module doesn't know anything about the content of the topic
349 There is one of these object for each file stored under RCSLite.
351 This object is PACKAGE PRIVATE to Store, and should NEVER be used from anywhere else.
355 - need to tidy up dealing with \\n for differences
356 - still have difficulty on line ending at end of sequences, consequence of doing a line based diff
358 ## <a name="File format"></a> File format
360 rcstext ::= admin {delta}* desc {deltatext}*
361 admin ::= head {num};
364 symbols {sym : num}*;
365 locks {id : num}*; {strict ;}
366 { comment {string}; }
382 digit ::= 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9
383 id ::= {num} idchar {idchar | num }*
384 sym ::= {digit}* idchar {idchar | digit }*
385 idchar ::= any visible graphic character except special
386 special ::= $ | , | . | : | ; | @
387 string ::= @{any character, with @ doubled}*@
388 newphrase ::= id word* ;
389 word ::= id | num | string | :
391 Identifiers are case sensitive. Keywords are in lower case only. The sets of keywords and identifiers can overlap. In most environments RCS uses the ISO 8859/1 encoding: visible graphic characters are codes 041-176 and 240-377, and white space characters are codes 010-015 and 040.
393 Dates, which appear after the date keyword, are of the form Y.mm.dd.hh.mm.ss, where Y is the year, mm the month (01-12), dd the day (01-31), hh the hour (00-23), mm the minute (00-59), and ss the second (00-60). Y contains just the last two digits of the year for years from 1900 through 1999, and all the digits of years thereafter. Dates use the Gregorian calendar; times use UTC.
395 The newphrase productions in the grammar are reserved for future extensions to the format of RCS files. No newphrase will begin with any keyword already in use.
397 Revisions consist of a sequence of 'a' and 'd' edits that need to be applied to rev N+1 to get rev N. Each edit has an offset (number of lines from start) and length (number of lines). For 'a', the edit is followed by length lines (the lines to be inserted in the text). For example:
399 d1 3 means "delete three lines starting with line 1 a4 2 means "insert two lines at line 4' xxxxxx is the new line 4 yyyyyy is the new line 5
401 This package has smell factor of **2**
403 ## <a name="TWiki::Store::_RcsWrap"></a> [[TWiki::Store::RcsWrap|Main/TWikiStoreRcsWrapDotPm]]
405 This package does not publish any methods. It implements the virtual methods of the [[TWiki::Store::RcsFile|Main/TWikiStoreRcsFileDotPm]] superclass.
407 Wrapper around the RCS commands required by TWiki. There is one of these object for each file stored under RCS.
409 This package has smell factor of **2**
411 ## <a name="TWiki::Templates"></a> [[TWiki::Templates|Main/TWikiTemplatesDotPm]]
413 Support for the TWiki template language.
415 This package has smell factor of **2**
417 ## <a name="TWiki::Time"></a> [[TWiki::Time|Main/TWikiTimeDotPm]]
419 Time handling functions.
421 This package has smell factor of **10**
423 ## <a name="TWiki::UI::_ChangeForm"></a> [[TWiki::UI::ChangeForm|Main/TWikiUIChangeFormDotPm]]
425 Service functions used by the UI packages
427 This package doesn't smell
429 ## <a name="TWiki::UI"></a> [[TWiki::UI|Main/TWikiUIDotPm]]
431 Service functions used by the UI packages
433 This package doesn't smell
435 ## <a name="TWiki::UI::Edit"></a> [[TWiki::UI::Edit|Main/TWikiUIEditDotPm]]
439 This package has smell factor of **1**
441 ## <a name="TWiki::UI::Manage"></a> [[TWiki::UI::Manage|Main/TWikiUIManageDotPm]]
443 UI functions for web, topic and user management
445 This package has smell factor of **5**
447 ## <a name="TWiki::UI::Oops"></a> [[TWiki::UI::Oops|Main/TWikiUIOopsDotPm]]
449 UI delegate for oops function
451 This package has smell factor of **1**
453 ## <a name="TWiki::UI::RDiff"></a> [[TWiki::UI::RDiff|Main/TWikiUIRDiffDotPm]]
455 UI functions for diffing.
457 This package has smell factor of **12**
459 ## <a name="TWiki::UI::Register"></a> [[TWiki::UI::Register|Main/TWikiUIRegisterDotPm]]
461 User registration handling.
463 This package has smell factor of **28**
465 ## <a name="TWiki::UI::Rest"></a> [[TWiki::UI::Rest|Main/TWikiUIRestDotPm]]
467 Rest delegate for view function
469 This package doesn't smell
471 ## <a name="TWiki::UI::Save"></a> [[TWiki::UI::Save|Main/TWikiUISaveDotPm]]
473 UI delegate for save function
475 This package has smell factor of **1**
477 ## <a name="TWiki::UI::Search"></a> [[TWiki::UI::Search|Main/TWikiUISearchDotPm]]
479 UI functions for searching.
481 This package has smell factor of **3**
483 ## <a name="TWiki::UI::Statistics"></a> [[TWiki::UI::Statistics|Main/TWikiUIStatisticsDotPm]]
485 Statistics extraction and presentation
487 This package has smell factor of **4**
489 ## <a name="TWiki::UI::Upload"></a> [[TWiki::UI::Upload|Main/TWikiUIUploadDotPm]]
491 UI delegate for attachment management functions
493 This package has smell factor of **5**
495 ## <a name="TWiki::UI::View"></a> [[TWiki::UI::View|Main/TWikiUIViewDotPm]]
497 UI delegate for view function
499 This package has smell factor of **1**
501 ## <a name="TWiki::User"></a> [[TWiki::User|Main/TWikiUserDotPm]]
503 A User object is an internal representation of a user in the real world. The object knows about users having login names, wiki names, personal topics, and email addresses.
505 This package has smell factor of **5**
507 ## <a name="TWiki::Users::_ApacheHtpasswdUse"></a> [[TWiki::Users::ApacheHtpasswdUser|Main/TWikiUsersApacheHtpasswdUserDotPm]]
509 Password manager that uses Apache::HtPasswd to manage users and passwords.
511 Subclass of [[ TWiki::Users::Password |Main/TWikiUsersPasswordDotPm]]. See documentation of that class for descriptions of the methods of this class.
513 Duplicates functionality of [[ =TWiki::Users::HtPasswdUser=|Main/TWikiUsersHtPasswdUserDotPm]]; provided mainly as an example of how to write a new password manager.
515 This package doesn't smell
517 ## <a name="TWiki::Users"></a> [[TWiki::Users|Main/TWikiUsersDotPm]]
519 Singleton object that handles mapping of users to wikinames and vice versa, and user authentication checking.
521 This package has smell factor of **4**
523 ## <a name="TWiki::Users::Password"></a> [[TWiki::Users::Password|Main/TWikiUsersPasswordDotPm]]
525 Base class of all password handlers. Default behaviour is no passwords, so anyone can be anyone they like.
527 The methods of this class should be overridded by subclasses that want to implement other password handling methods.
529 This package doesn't smell
531 There were a total of **231** smells