buildrelease
[openafs-wiki.git] / TWiki / SourceCode.mdwn
1 # <a name="TWiki Source Code Packages"></a><a name=" TWiki Source Code Packages"></a> TWiki Source Code Packages
2
3 %X% This documentation is automatically generated from the `pod`, so it always matches the running code
4
5 <div>
6   <ul>
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::Meta"> TWiki::Meta </a></li>
23     <li><a href="#TWiki::Net"> TWiki::Net </a></li>
24     <li><a href="#TWiki::_OopsException"> TWiki::OopsException </a></li>
25     <li><a href="#"> </a></li>
26     <li><a href="#TWiki::Plugins"> TWiki::Plugins </a></li>
27     <li><a href="#TWiki::Plurals"> TWiki::Plurals </a></li>
28     <li><a href="#TWiki::Prefs"> TWiki::Prefs </a></li>
29     <li><a href="#TWiki::Prefs::Parser"> TWiki::Prefs::Parser </a></li>
30     <li><a href="#TWiki::Prefs::_PrefsCache"> TWiki::Prefs::PrefsCache </a></li>
31     <li><a href="#TWiki::Render"> TWiki::Render </a></li>
32     <li><a href="#TWiki::Sandbox"> TWiki::Sandbox </a></li>
33     <li><a href="#TWiki::Search"> TWiki::Search </a></li>
34     <li><a href="#TWiki::Store"> TWiki::Store </a></li>
35     <li><a href="#TWiki::Store::_RcsFile"> TWiki::Store::RcsFile </a></li>
36     <li><a href="#TWiki::Store::_RcsLite"> TWiki::Store::RcsLite </a></li>
37     <li><a href="#File format"> File format</a></li>
38     <li><a href="#TWiki::Store::_RcsWrap"> TWiki::Store::RcsWrap </a></li>
39     <li><a href="#TWiki::Templates"> TWiki::Templates </a></li>
40     <li><a href="#TWiki::Time"> TWiki::Time </a></li>
41     <li><a href="#TWiki::UI::_ChangeForm"> TWiki::UI::ChangeForm </a></li>
42     <li><a href="#TWiki::UI"> TWiki::UI </a></li>
43     <li><a href="#TWiki::UI::Edit"> TWiki::UI::Edit </a></li>
44     <li><a href="#TWiki::UI::Manage"> TWiki::UI::Manage </a></li>
45     <li><a href="#TWiki::UI::Oops"> TWiki::UI::Oops </a></li>
46     <li><a href="#TWiki::UI::RDiff"> TWiki::UI::RDiff </a></li>
47     <li><a href="#TWiki::UI::Register"> TWiki::UI::Register </a></li>
48     <li><a href="#TWiki::UI::Rest"> TWiki::UI::Rest </a></li>
49     <li><a href="#TWiki::UI::Save"> TWiki::UI::Save </a></li>
50     <li><a href="#TWiki::UI::Search"> TWiki::UI::Search </a></li>
51     <li><a href="#TWiki::UI::Statistics"> TWiki::UI::Statistics </a></li>
52     <li><a href="#TWiki::UI::Upload"> TWiki::UI::Upload </a></li>
53     <li><a href="#TWiki::UI::View"> TWiki::UI::View </a></li>
54     <li><a href="#TWiki::User"> TWiki::User </a></li>
55     <li><a href="#TWiki::Users::_ApacheHtpasswdUse"> TWiki::Users::ApacheHtpasswdUser </a></li>
56     <li><a href="#TWiki::Users"> TWiki::Users </a></li>
57     <li><a href="#TWiki::Users::Password"> TWiki::Users::Password </a></li>
58   </ul>
59 </div>
60
61 ## <a name="TWiki::_AccessControlException"></a> [[TWiki::AccessControlException|Main/TWikiAccessControlExceptionDotPm]]
62
63 Exception used raise an access control violation.
64
65 This package doesn't smell
66
67 ## <a name="TWiki::Access"></a> [[TWiki::Access|Main/TWikiAccessDotPm]]
68
69 A singleton object of this class manages the access control database.
70
71 This package has smell factor of **1**
72
73 ## <a name="TWiki::Attach"></a> [[TWiki::Attach|Main/TWikiAttachDotPm]]
74
75 A singleton object of this class is used to deal with attachments to topics.
76
77 This package has smell factor of **2**
78
79 ## <a name="TWiki::Attrs"></a> [[TWiki::Attrs|Main/TWikiAttrsDotPm]]
80
81 Class of attribute sets, designed for parsing and storing attribute values from a TWiki tag e.g. `%TAG{fred='bad' "sad" joe="mad"}%`
82
83 An attribute set is a map containing an entry for each parameter. The default parameter (unnamed quoted string) is named `_DEFAULT` in the map.
84
85 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.
86
87 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`.
88
89 This class replaces the old TWiki::extractNameValuePair and TWiki::extractParameters.
90
91 This package doesn't smell
92
93 ## <a name="TWiki::Client::_ApacheLogin"></a> [[TWiki::Client::ApacheLogin|Main/TWikiClientApacheLoginDotPm]]
94
95 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 &amp; 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.
96
97 See also [[TWikiUserAuthentication]].
98
99 Subclass of TWiki::Client; see that class for documentation of the methods of this class.
100
101 This package doesn't smell
102
103 ## <a name="TWiki::Client"></a> [[TWiki::Client|Main/TWikiClientDotPm]]
104
105 The package is also a Factory for login managers and also the base class for all login managers.
106
107 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.
108
109 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.
110
111 This package has smell factor of **3**
112
113 ## <a name="TWiki::Client::_TemplateLogin"></a> [[TWiki::Client::TemplateLogin|Main/TWikiClientTemplateLoginDotPm]]
114
115 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.
116
117 Subclass of TWiki::Client; see that class for documentation of the methods of this class.
118
119 This package has smell factor of **2**
120
121 ## <a name="TWiki::Compatibility"></a> [[TWiki::Compatibility|Main/TWikiCompatibilityDotPm]]
122
123 Support for compatibility with old TWiki versions. Packaged separately because 99.999999% of the time this won't be needed.
124
125 =end
126
127 sub \_upgradeCategoryItem \{ my ( $catitems, $ctext ) = @\_; my $catname = ''; my $scatname = ''; my $catmodifier = ''; my $catvalue = ''; my @cmd = split( /\\|/, $catitems ); my $src = ''; my $len = @cmd; if( $len &lt; '2' ) \{ # FIXME return ( $catname, $catmodifier, $catvalue ) \} my $svalue = '';
128
129 my $i; my $itemsPerLine;
130
131 # check for [[CategoryName]]=CategoryValue parameter my $paramCmd = ''; my $cvalue = ''; # was$query-&gt;param( $cmd[1] ); if( $cvalue ) \{ $src = "$cvalue"; \} elsif( $ctext ) \{ foreach( split( /\\r?\\n/, $ctext ) ) \{ if( /$cmd[1]/ ) \{ $src = $\_; last; \} \} \}
132
133 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 &lt; $len; $i++ ) \{ my $value = $cmd[$i]; $svalue = $value; if( $src =~ /$value/ ) \{ $catvalue = $svalue; \} \}
134
135 \} 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 &lt; $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; \} \}
136
137 \} 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; \}
138
139 return ( $catname, $catmodifier, $catvalue ) \}
140
141 This package has smell factor of **2**
142
143 ## <a name="TWiki"></a> [[TWiki|Main/TWikiDotPm]]
144
145 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.
146
147 Global variables are avoided wherever possible to avoid problems with CGI accelerators such as mod\_perl.
148
149 This package has smell factor of **29**
150
151 ## <a name="TWiki::Form"></a> [[TWiki::Form|Main/TWikiFormDotPm]]
152
153 Object representing a single form definition.
154
155 This package has smell factor of **10**
156
157 ## <a name="TWiki::Func"></a> [[TWiki::Func|Main/TWikiFuncDotPm]]
158
159 _Official list of stable TWiki functions for Plugin developers_
160
161 This module defines official functions that [[Plugins|TWiki/TWikiPlugins]] can use to interact with the TWiki engine and content.
162
163 Refer to [[EmptyPlugin]] and lib/TWiki/Plugins/EmptyPlugin.pm for a template Plugin and documentation on how to write a Plugin.
164
165 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.
166
167 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.
168
169 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.
170
171 **_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,
172
173     use TWiki;
174     print TWiki::Func::getSkin(),"\n";
175
176 will fail with `Can't call method "getSkin" on an undefined value at TWiki/Func.pm line 83`.
177
178 If you want to call the methods outside the context of a plugin, you can create a Plugins SESSION object. For example, the script:
179
180     use TWiki:
181     $TWiki::Plugins::SESSION = new TWiki();
182     print TWiki::Func::getSkin(),"\n";
183
184 will work happily.
185
186 This package has smell factor of **1**
187
188 ## <a name="TWiki::_I18N"></a> [[TWiki::I18N|Main/TWikiI18NDotPm]]
189
190 Support for strings translation and language detection.
191
192 This package has smell factor of **2**
193
194 ## <a name="TWiki::_I18N::Extract"></a> [[TWiki::I18N::Extract|Main/TWikiI18NExtractDotPm]]
195
196 Support translatable strings extraction from TWiki topics and templates. Depends on Locale::Maketext::Extract (part of CPAN::Locale::Maketext::Lexicon).
197
198 This package has smell factor of **1**
199
200 ## <a name="TWiki::If"></a> [[TWiki::If|Main/TWikiIfDotPm]]
201
202 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.
203
204 This package doesn't smell
205
206 ## <a name="TWiki::Merge"></a> [[TWiki::Merge|Main/TWikiMergeDotPm]]
207
208 Support for merging strings
209
210 This package has smell factor of **1**
211
212 ## <a name="TWiki::Meta"></a> [[TWiki::Meta|Main/TWikiMetaDotPm]]
213
214 Meta-data handling.
215
216 A meta-data object is a hash of different types of meta-data (keyed on the type, such as 'FIELD' and 'TOPICINFO').
217
218 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.
219
220 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.
221
222 For unkeyed types, the array has only one entry.
223
224 The module knows nothing about how meta-data is stored. That is entirely the responsibility of the Store module.
225
226 Meta-data objects are created by the Store engine when topics are read. They are populated using the `put` method.
227
228 This package has smell factor of **6**
229
230 ## <a name="TWiki::Net"></a> [[TWiki::Net|Main/TWikiNetDotPm]]
231
232 Object that brokers access to network resources.
233
234 This package has smell factor of **2**
235
236 ## <a name="TWiki::_OopsException"></a> [[TWiki::OopsException|Main/TWikiOopsExceptionDotPm]]
237
238 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.
239
240 This package doesn't smell
241
242 ## <> \[[TWikiPluginDotPm]\[]]
243
244 This package has smell factor of **2**
245
246 ## <a name="TWiki::Plugins"></a> [[TWiki::Plugins|Main/TWikiPluginsDotPm]]
247
248 This module defines the singleton object that handles Plugins loading, initialization and execution.
249
250 This class uses Chain of Responsibility (GOF) pattern to dispatch handler calls to registered plugins.
251
252 This package doesn't smell
253
254 ## <a name="TWiki::Plurals"></a> [[TWiki::Plurals|Main/TWikiPluralsDotPm]]
255
256 Handle conversion of plural topic names to singular form.
257
258 This package has smell factor of **3**
259
260 ## <a name="TWiki::Prefs"></a> [[TWiki::Prefs|Main/TWikiPrefsDotPm]]
261
262 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.
263
264 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.
265
266 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!)
267
268 This package has smell factor of **1**
269
270 ## <a name="TWiki::Prefs::Parser"></a> [[TWiki::Prefs::Parser|Main/TWikiPrefsParserDotPm]]
271
272 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.
273
274 This class does no validation or duplicate-checking on the settings; it simply returns the recognized settings in the order it sees them in.
275
276 This package has smell factor of **1**
277
278 ## <a name="TWiki::Prefs::_PrefsCache"></a> [[TWiki::Prefs::PrefsCache|Main/TWikiPrefsPrefsCacheDotPm]]
279
280 The [[PrefsCache]] package holds a cache of topics that have been read in, using the [[TopicPrefs]] class. These functions manage that cache.
281
282 We maintain 2 hashes of values:
283
284 - \{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.
285 - \{values\} contains all sets, locals, and all values inherited from the parent level
286
287 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.
288
289 This package has smell factor of **1**
290
291 ## <a name="TWiki::Render"></a> [[TWiki::Render|Main/TWikiRenderDotPm]]
292
293 This module provides most of the actual HTML rendering code in TWiki.
294
295 This package has smell factor of **23**
296
297 ## <a name="TWiki::Sandbox"></a> [[TWiki::Sandbox|Main/TWikiSandboxDotPm]]
298
299 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.
300
301 This package has smell factor of **3**
302
303 ## <a name="TWiki::Search"></a> [[TWiki::Search|Main/TWikiSearchDotPm]]
304
305 This module implements all the search functionality.
306
307 This package has smell factor of **22**
308
309 ## <a name="TWiki::Store"></a> [[TWiki::Store|Main/TWikiStoreDotPm]]
310
311 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.
312
313 This module knows nothing about how the data is actually _stored_ - that knowledge is entirely encapsulated in the handlers.
314
315 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.
316
317 This package has smell factor of **18**
318
319 ## <a name="TWiki::Store::_RcsFile"></a> [[TWiki::Store::RcsFile|Main/TWikiStoreRcsFileDotPm]]
320
321 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.
322
323 The general contract of the methods on this class and its subclasses calls for errors to be signalled by Error::Simple exceptions.
324
325 Refer to Store.pm for models of usage.
326
327 This package has smell factor of **10**
328
329 ## <a name="TWiki::Store::_RcsLite"></a> [[TWiki::Store::RcsLite|Main/TWikiStoreRcsLiteDotPm]]
330
331 This package does not publish any methods. It implements the virtual methods of the [[TWiki::Store::RcsFile|Main/TWikiStoreRcsFileDotPm]] superclass.
332
333 Simple replacement for RCS. Doesn't support:
334
335 - branches
336 - locking
337
338 Neither of which are used (or needed) by TWiki.
339
340 This module doesn't know anything about the content of the topic
341
342 There is one of these object for each file stored under RCSLite.
343
344 This object is PACKAGE PRIVATE to Store, and should NEVER be used from anywhere else.
345
346 FIXME:
347
348 - need to tidy up dealing with \\n for differences
349 - still have difficulty on line ending at end of sequences, consequence of doing a line based diff
350
351 ## <a name="File format"></a> File format
352
353     rcstext    ::=  admin {delta}* desc {deltatext}*
354     admin      ::=  head {num};
355                     { branch   {num}; }
356                     access {id}*;
357                     symbols {sym : num}*;
358                     locks {id : num}*;  {strict  ;}
359                     { comment  {string}; }
360                     { expand   {string}; }
361                     { newphrase }*
362     delta      ::=  num
363                     date num;
364                     author id;
365                     state {id};
366                     branches {num}*;
367                     next {num};
368                     { newphrase }*
369     desc       ::=  desc string
370     deltatext  ::=  num
371                     log string
372                     { newphrase }*
373                     text string
374     num        ::=  {digit | .}+
375     digit      ::=  0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9
376     id         ::=  {num} idchar {idchar | num }*
377     sym        ::=  {digit}* idchar {idchar | digit }*
378     idchar     ::=  any visible graphic character except special
379     special    ::=  $ | , | . | : | ; | @
380     string     ::=  @{any character, with @ doubled}*@
381     newphrase  ::=  id word* ;
382     word       ::=  id | num | string | :
383
384 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.
385
386 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.
387
388 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.
389
390 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:
391
392 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
393
394 This package has smell factor of **2**
395
396 ## <a name="TWiki::Store::_RcsWrap"></a> [[TWiki::Store::RcsWrap|Main/TWikiStoreRcsWrapDotPm]]
397
398 This package does not publish any methods. It implements the virtual methods of the [[TWiki::Store::RcsFile|Main/TWikiStoreRcsFileDotPm]] superclass.
399
400 Wrapper around the RCS commands required by TWiki. There is one of these object for each file stored under RCS.
401
402 This package has smell factor of **2**
403
404 ## <a name="TWiki::Templates"></a> [[TWiki::Templates|Main/TWikiTemplatesDotPm]]
405
406 Support for the TWiki template language.
407
408 This package has smell factor of **2**
409
410 ## <a name="TWiki::Time"></a> [[TWiki::Time|Main/TWikiTimeDotPm]]
411
412 Time handling functions.
413
414 This package has smell factor of **10**
415
416 ## <a name="TWiki::UI::_ChangeForm"></a> [[TWiki::UI::ChangeForm|Main/TWikiUIChangeFormDotPm]]
417
418 Service functions used by the UI packages
419
420 This package doesn't smell
421
422 ## <a name="TWiki::UI"></a> [[TWiki::UI|Main/TWikiUIDotPm]]
423
424 Service functions used by the UI packages
425
426 This package doesn't smell
427
428 ## <a name="TWiki::UI::Edit"></a> [[TWiki::UI::Edit|Main/TWikiUIEditDotPm]]
429
430 Edit command handler
431
432 This package has smell factor of **1**
433
434 ## <a name="TWiki::UI::Manage"></a> [[TWiki::UI::Manage|Main/TWikiUIManageDotPm]]
435
436 UI functions for web, topic and user management
437
438 This package has smell factor of **5**
439
440 ## <a name="TWiki::UI::Oops"></a> [[TWiki::UI::Oops|Main/TWikiUIOopsDotPm]]
441
442 UI delegate for oops function
443
444 This package has smell factor of **1**
445
446 ## <a name="TWiki::UI::RDiff"></a> [[TWiki::UI::RDiff|Main/TWikiUIRDiffDotPm]]
447
448 UI functions for diffing.
449
450 This package has smell factor of **12**
451
452 ## <a name="TWiki::UI::Register"></a> [[TWiki::UI::Register|Main/TWikiUIRegisterDotPm]]
453
454 User registration handling.
455
456 This package has smell factor of **28**
457
458 ## <a name="TWiki::UI::Rest"></a> [[TWiki::UI::Rest|Main/TWikiUIRestDotPm]]
459
460 Rest delegate for view function
461
462 This package doesn't smell
463
464 ## <a name="TWiki::UI::Save"></a> [[TWiki::UI::Save|Main/TWikiUISaveDotPm]]
465
466 UI delegate for save function
467
468 This package has smell factor of **1**
469
470 ## <a name="TWiki::UI::Search"></a> [[TWiki::UI::Search|Main/TWikiUISearchDotPm]]
471
472 UI functions for searching.
473
474 This package has smell factor of **3**
475
476 ## <a name="TWiki::UI::Statistics"></a> [[TWiki::UI::Statistics|Main/TWikiUIStatisticsDotPm]]
477
478 Statistics extraction and presentation
479
480 This package has smell factor of **4**
481
482 ## <a name="TWiki::UI::Upload"></a> [[TWiki::UI::Upload|Main/TWikiUIUploadDotPm]]
483
484 UI delegate for attachment management functions
485
486 This package has smell factor of **5**
487
488 ## <a name="TWiki::UI::View"></a> [[TWiki::UI::View|Main/TWikiUIViewDotPm]]
489
490 UI delegate for view function
491
492 This package has smell factor of **1**
493
494 ## <a name="TWiki::User"></a> [[TWiki::User|Main/TWikiUserDotPm]]
495
496 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.
497
498 This package has smell factor of **5**
499
500 ## <a name="TWiki::Users::_ApacheHtpasswdUse"></a> [[TWiki::Users::ApacheHtpasswdUser|Main/TWikiUsersApacheHtpasswdUserDotPm]]
501
502 Password manager that uses Apache::HtPasswd to manage users and passwords.
503
504 Subclass of [[ TWiki::Users::Password |Main/TWikiUsersPasswordDotPm]]. See documentation of that class for descriptions of the methods of this class.
505
506 Duplicates functionality of [[ =TWiki::Users::HtPasswdUser=|Main/TWikiUsersHtPasswdUserDotPm]]; provided mainly as an example of how to write a new password manager.
507
508 This package doesn't smell
509
510 ## <a name="TWiki::Users"></a> [[TWiki::Users|Main/TWikiUsersDotPm]]
511
512 Singleton object that handles mapping of users to wikinames and vice versa, and user authentication checking.
513
514 This package has smell factor of **4**
515
516 ## <a name="TWiki::Users::Password"></a> [[TWiki::Users::Password|Main/TWikiUsersPasswordDotPm]]
517
518 Base class of all password handlers. Default behaviour is no passwords, so anyone can be anyone they like.
519
520 The methods of this class should be overridded by subclasses that want to implement other password handling methods.
521
522 This package doesn't smell
523
524 There were a total of **232** smells