TWiki/TWikiStoreDotPm.mdwn

   1 # <a name="Package &lt;code&gt;TWiki::Store="></a> Package =TWiki::Store
   2
   3 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.
   4
   5 This module knows nothing about how the data is actually _stored_ - that knowledge is entirely encapsulated in the handlers.
   6
   7 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.
   8
   9 <div>
  10   <ul>
  11     <li><a href="#Package =TWiki::Store="> Package TWiki::Store</a><ul>
  12         <li><a href="#ClassMethod <strong>new</strong> ()"> ClassMethod new <tt>()</tt></a></li>
  13         <li><a href="#ObjectMethod <strong>readTopic</strong> ($user,"> ObjectMethod readTopic <tt>($user,$web,$topic,$version) -&gt; ($metaObject,$text)</tt></a></li>
  14         <li><a href="#ObjectMethod <strong>read_TopicRaw</strong> ($u"> ObjectMethod readTopicRaw <tt>($user,$web,$topic,$version) -&gt; $topicText</tt></a></li>
  15         <li><a href="#ObjectMethod <strong>moveAttachment</strong> ($"> ObjectMethod moveAttachment <tt>($oldWeb,$oldTopic,$oldAttachment,$newWeb,$newTopic,$newAttachment,$user)</tt></a></li>
  16         <li><a href="#ObjectMethod *get_AttachmentStre"> ObjectMethod getAttachmentStream <tt>($user,$web,$topic,$attName) -&gt; \*STREAM</tt></a></li>
  17         <li><a href="#ObjectMethod *get_AttachmentList"> ObjectMethod getAttachmentList <tt>($web,$topic)</tt></a></li>
  18         <li><a href="#ObjectMethod *attachmentExists*"> ObjectMethod attachmentExists <tt>($web,$topic,$att) -&gt; $boolean</tt></a></li>
  19         <li><a href="#ObjectMethod *_remove_AutoAttach"> ObjectMethod _removeAutoAttachmentsFromMeta <tt></tt></a></li>
  20         <li><a href="#ObjectMethod <strong>moveTopic</strong> ($oldWe"> ObjectMethod moveTopic <tt>($oldWeb,$oldTopic,$newWeb,$newTopic,$user)</tt></a></li>
  21         <li><a href="#ObjectMethod <strong>moveWeb</strong> ($oldWeb,"> ObjectMethod moveWeb <tt>($oldWeb,$newWeb,$user)</tt></a></li>
  22         <li><a href="#ObjectMethod <strong>readAttachment</strong> ($"> ObjectMethod readAttachment <tt>($user,$web,$topic,$attachment,$theRev) -&gt; $text</tt></a></li>
  23         <li><a href="#ObjectMethod *get_RevisionNumber"> ObjectMethod getRevisionNumber <tt>($web,$topic,$attachment) -&gt; $integer</tt></a></li>
  24         <li><a href="#ObjectMethod <strong>get_WorkArea</strong> ($ke"> ObjectMethod getWorkArea <tt>($key) -&gt; $directorypath</tt></a></li>
  25         <li><a href="#ObjectMethod *get_RevisionDiff*"> ObjectMethod getRevisionDiff <tt>($web,$topic,$rev1,$rev2,$contextLines) -&gt; \@diffArray</tt></a></li>
  26         <li><a href="#ObjectMethod *get_RevisionInfo*"> ObjectMethod getRevisionInfo <tt>($web,$topic,$rev,$attachment) -&gt; ($date,$user,$rev,$comment)</tt></a></li>
  27         <li><a href="#StaticMethod <strong>dataEncode</strong> ($unco"> StaticMethod dataEncode <tt>($uncoded) -&gt; $coded</tt></a></li>
  28         <li><a href="#StaticMethod <strong>dataDecode</strong> ($enco"> StaticMethod dataDecode <tt>($encoded) -&gt; $decoded</tt></a></li>
  29         <li><a href="#ObjectMethod <strong>saveTopic</strong> ($user,"> ObjectMethod saveTopic <tt>($user,$web,$topic,$text,$meta,$options)</tt></a></li>
  30         <li><a href="#ObjectMethod <strong>saveAttachment</strong> ($"> ObjectMethod saveAttachment <tt>($web,$topic,$attachment,$user,$opts)</tt></a></li>
  31         <li><a href="#ObjectMethod <strong>repRev</strong> ($user,$we"> ObjectMethod repRev <tt>($user,$web,$topic,$text,$meta,$options)</tt></a></li>
  32         <li><a href="#ObjectMethod <strong>delRev</strong> ($user,$we"> ObjectMethod delRev <tt>($user,$web,$topic,$text,$meta,$options)</tt></a></li>
  33         <li><a href="#ObjectMethod <strong>lockTopic</strong> ($web,$"> ObjectMethod lockTopic <tt>($web,$topic)</tt></a></li>
  34         <li><a href="#ObjectMethod <strong>unlockTopic</strong> ($use"> ObjectMethod unlockTopic <tt>($user,$web,$topic)</tt></a></li>
  35         <li><a href="#ObjectMethod <strong>webExists</strong> ($web)"> ObjectMethod webExists <tt>($web) -&gt; $boolean</tt></a></li>
  36         <li><a href="#ObjectMethod <strong>topicExists</strong> ($web"> ObjectMethod topicExists <tt>($web,$topic) -&gt; $boolean</tt></a></li>
  37         <li><a href="#ObjectMethod <strong>get_TopicParent</strong> ("> ObjectMethod getTopicParent <tt>($web,$topic) -&gt; $string</tt></a></li>
  38         <li><a href="#ObjectMethod *get_TopicLatestRev"> ObjectMethod getTopicLatestRevTime <tt>($web,$topic) -&gt; $epochSecs</tt></a></li>
  39         <li><a href="#ObjectMethod <strong>read_MetaData</strong> ($w"> ObjectMethod readMetaData <tt>($web,$name) -&gt; $text</tt></a></li>
  40         <li><a href="#ObjectMethod <strong>save_MetaData</strong> ($w"> ObjectMethod saveMetaData <tt>($web,$name) -&gt; $text</tt></a></li>
  41         <li><a href="#ObjectMethod <strong>get_TopicNames</strong> ($"> ObjectMethod getTopicNames <tt>($web) -&gt; @topics</tt></a></li>
  42         <li><a href="#ObjectMethod <strong>get_ListOfWebs</strong> ($"> ObjectMethod getListOfWebs <tt>($filter) -&gt; @webNames</tt></a></li>
  43         <li><a href="#ObjectMethod <strong>createWeb</strong> ($user,"> ObjectMethod createWeb <tt>($user,$newWeb,$baseWeb,$opts)</tt></a></li>
  44         <li><a href="#ObjectMethod <strong>removeWeb</strong> ($user,"> ObjectMethod removeWeb <tt>($user,$web)</tt></a></li>
  45         <li><a href="#ObjectMethod <strong>get_DebugText</strong> ($m"> ObjectMethod getDebugText <tt>($meta,$text) -&gt; $text</tt></a></li>
  46         <li><a href="#ObjectMethod <strong>clean_UpRevID</strong> ($r"> ObjectMethod cleanUpRevID <tt>($rev) -&gt; $integer</tt></a></li>
  47         <li><a href="#ObjectMethod <strong>copyTopic</strong> ($user,"> ObjectMethod copyTopic <tt>($user,$fromweb,$fromtopic,$toweb,$totopic)</tt></a></li>
  48         <li><a href="#ObjectMethod <strong>search_MetaData</strong> ("> ObjectMethod searchMetaData <tt>($params) -&gt; $text</tt></a></li>
  49         <li><a href="#ObjectMethod *search_InWebConten"> ObjectMethod searchInWebContent <tt>($searchString,$web,\@topics,\%options) -&gt; \%map</tt></a></li>
  50         <li><a href="#ObjectMethod *get_RevisionAtTime"> ObjectMethod getRevisionAtTime <tt>($web,$topic,$time) -&gt; $rev</tt></a></li>
  51         <li><a href="#ObjectMethod <strong>getLease</strong> ($web,$t"> ObjectMethod getLease <tt>($web,$topic) -&gt; $lease</tt></a></li>
  52         <li><a href="#ObjectMethod <strong>setLease</strong> ($web,$t"> ObjectMethod setLease <tt>($web,$topic,$user,$length)</tt></a></li>
  53         <li><a href="#ObjectMethod <strong>clearLease</strong> ($web,"> ObjectMethod clearLease <tt>($web,$topic)</tt></a></li>
  54       </ul>
  55     </li>
  56   </ul>
  57 </div>
  58
  59 ## <a name="ClassMethod &lt;strong&gt;new&lt;/strong&gt; ()"></a> [[ClassMethod]] **new** `()`
  60
  61 Construct a Store module, linking in the chosen sub-implementation.
  62
  63 ## <a name="ObjectMethod &lt;strong&gt;readTopic&lt;/strong&gt; ($user,"></a> [[ObjectMethod]] **readTopic** `($user,$web,$topic,$version) -> ($metaObject,$text)`
  64
  65 Reads the given version of a topic and it's meta-data. If the version is undef, then read the most recent version. The version number must be an integer, or undef for the latest version.
  66
  67 If $user is defined, view permission will be required for the topic read to be successful. Access control violations are flagged by a TWiki::AccessControlException. Permissions are checked for the user name passed in.
  68
  69 If the topic contains a web specification (is of the form Web.Topic) the web specification will override whatever is passed in $web.
  70
  71 The metadata and topic text are returned separately, with the metadata in a TWiki::Meta object. (The topic text is, as usual, just a string.)
  72
  73 ## <a name="ObjectMethod &lt;strong&gt;read_TopicRaw&lt;/strong&gt; ($u"></a> [[ObjectMethod]] **readTopicRaw** `($user,$web,$topic,$version) -> $topicText`
  74
  75 Reads the given version of a topic, without separating out any embedded meta-data. If the version is undef, then read the most recent version. The version number must be an integer or undef.
  76
  77 If $user is defined, view permission will be required for the topic read to be successful. Access control violations are flagged by a TWiki::AccessControlException. Permissions are checked for the user name passed in.
  78
  79 If the topic contains a web specification (is of the form Web.Topic) the web specification will override whatever is passed in $web.
  80
  81 SMELL: DO NOT CALL THIS METHOD UNLESS YOU HAVE NO CHOICE. This method breaks encapsulation of the store, as it assumes meta is stored embedded in the text. Other implementors of store will be forced to insert meta-data to ensure correct operation of View raw=debug and the 'repRev' mode of Edit.
  82
  83 $web and $topic _must_ be untainted.
  84
  85 ## <a name="ObjectMethod &lt;strong&gt;moveAttachment&lt;/strong&gt; ($"></a> [[ObjectMethod]] **moveAttachment** `($oldWeb,$oldTopic,$oldAttachment,$newWeb,$newTopic,$newAttachment,$user)`
  86
  87 Move an attachment from one topic to another.
  88
  89 The caller to this routine should check that all topics are valid.
  90
  91 All parameters must be defined, and must be untainted.
  92
  93 ## <a name="ObjectMethod &lt;strong&gt;get_AttachmentStre"></a> [[ObjectMethod]] \*getAttachmentStream `($user,$web,$topic,$attName) -> \*STREAM`
  94
  95 - `$user` - the user doing the reading, or undef if no access checks
  96 - `$web` - The web
  97 - `$topic` - The topic
  98 - `$attName` - Name of the attachment
  99
 100 Open a standard input stream from an attachment.
 101
 102 If $user is defined, view permission will be required for the topic read to be successful. Access control violations and errors will cause exceptions to be thrown.
 103
 104 Permissions are checked for the user name passed in.
 105
 106 ## <a name="ObjectMethod &lt;strong&gt;get_AttachmentList"></a> [[ObjectMethod]] \*getAttachmentList `($web,$topic)`
 107
 108 returns @($attachmentName =&gt; [stat]) for any given web, topic
 109
 110 ## <a name="ObjectMethod &lt;strong&gt;attachmentExists*"></a><a name="ObjectMethod *attachmentExists&lt;/strong&gt; "></a> [[ObjectMethod]] **attachmentExists** `($web,$topic,$att) -> $boolean`
 111
 112 Determine if the attachment already exists on the given topic
 113
 114 ## <a name="ObjectMethod &lt;strong&gt;_remove_AutoAttach"></a> [[ObjectMethod]] \*\_removeAutoAttachmentsFromMeta ``
 115
 116 This is where we are going to remove from meta any entry that is marked as an automatic attachment.
 117
 118 ## <a name="ObjectMethod &lt;strong&gt;moveTopic&lt;/strong&gt; ($oldWe"></a> [[ObjectMethod]] **moveTopic** `($oldWeb,$oldTopic,$newWeb,$newTopic,$user)`
 119
 120 All parameters must be defined and must be untainted.
 121
 122 ## <a name="ObjectMethod &lt;strong&gt;moveWeb&lt;/strong&gt; ($oldWeb,"></a> [[ObjectMethod]] **moveWeb** `($oldWeb,$newWeb,$user)`
 123
 124 Move a web.
 125
 126 All parrameters must be defined and must be untainted.
 127
 128 ## <a name="ObjectMethod &lt;strong&gt;readAttachment&lt;/strong&gt; ($"></a> [[ObjectMethod]] **readAttachment** `($user,$web,$topic,$attachment,$theRev) -> $text`
 129
 130 Read the given version of an attachment, returning the content.
 131
 132 View permission on the topic is required for the read to be successful. Access control violations are flagged by a TWiki::AccessControlException. Permissions are checked for the user passed in.
 133
 134 If $theRev is not given, the most recent rev is assumed.
 135
 136 ## <a name="ObjectMethod &lt;strong&gt;get_RevisionNumber"></a> [[ObjectMethod]] \*getRevisionNumber `($web,$topic,$attachment) -> $integer`
 137
 138 Get the revision number of the most recent revision. Returns the integer revision number or '' if the topic doesn't exist.
 139
 140 WORKS FOR ATTACHMENTS AS WELL AS TOPICS
 141
 142 ## <a name="ObjectMethod &lt;strong&gt;get_WorkArea&lt;/strong&gt; ($ke"></a> [[ObjectMethod]] **getWorkArea** `($key) -> $directorypath`
 143
 144 Gets a private directory uniquely identified by $key. The directory is intended as a work area for plugins. The directory will exist.
 145
 146 ## <a name="ObjectMethod &lt;strong&gt;get_RevisionDiff*"></a><a name="ObjectMethod *get_RevisionDiff&lt;/strong&gt; "></a> [[ObjectMethod]] **getRevisionDiff** `($web,$topic,$rev1,$rev2,$contextLines) -> \@diffArray`
 147
 148 Return reference to an array of [ diffType, $right, $left ]
 149
 150 - `$web` - the web
 151 - `$topic` - the topic
 152 - `$rev1` Integer revision number
 153 - `$rev2` Integer revision number
 154 - `$contextLines` - number of lines of context required
 155
 156 ## <a name="ObjectMethod &lt;strong&gt;get_RevisionInfo*"></a><a name="ObjectMethod *get_RevisionInfo&lt;/strong&gt; "></a> [[ObjectMethod]] **getRevisionInfo** `($web,$topic,$rev,$attachment) -> ($date,$user,$rev,$comment)`
 157
 158 Get revision info of a topic.
 159
 160 - `$web` Web name, optional, e.g. `'Main'`
 161 - `$topic` Topic name, required, e.g. `'TokyoOffice'`
 162 - `$rev` revision number. If 0, undef, or out-of-range, will get info about the most recent revision.
 163 - `$attachment` attachment filename; undef for a topic
 164
 165 Return list with: ( last update date, last user object, =
 166
 167 <table border="1" cellpadding="0" cellspacing="0">
 168   <tr>
 169     <td> $date </td>
 170     <td> in epochSec </td>
 171   </tr>
 172   <tr>
 173     <td> $user </td>
 174     <td> user <strong>object</strong></td>
 175   </tr>
 176   <tr>
 177     <td> $rev </td>
 178     <td> the revision number </td>
 179   </tr>
 180   <tr>
 181     <td> $comment </td>
 182     <td> WHAT COMMENT? </td>
 183   </tr>
 184 </table>
 185
 186 e.g. =( 1234561, 'phoeny', 5, 'no comment' )
 187
 188 NOTE NOTE NOTE if you are working within the TWiki code DO NOT USE THIS FUNCTION FOR GETTING REVISION INFO OF TOPICS - use TWiki::Meta::getRevisionInfo instead. This is essential to allow clean transition to a topic object model later, and avoids the risk of confusion coming from meta and Store revision information being out of step. (it's OK to use it for attachments)
 189
 190 ## <a name="StaticMethod &lt;strong&gt;dataEncode&lt;/strong&gt; ($unco"></a> [[StaticMethod]] **dataEncode** `($uncoded) -> $coded`
 191
 192 Encode meta-data fields, escaping out selected characters. The encoding is chosen to avoid problems with parsing the attribute values, while minimising the number of characters encoded so searches can still work (fairly) sensibly.
 193
 194 The encoding has to be exported because TWiki (and plugins) use encoded field data in other places e.g. RDiff, mainly as a shorthand for the properly parsed meta object. Some day we may be able to eliminate that....
 195
 196 ## <a name="StaticMethod &lt;strong&gt;dataDecode&lt;/strong&gt; ($enco"></a> [[StaticMethod]] **dataDecode** `($encoded) -> $decoded`
 197
 198 Decode escapes in a string that was encoded using dataEncode
 199
 200 The encoding has to be exported because TWiki (and plugins) use encoded field data in other places e.g. RDiff, mainly as a shorthand for the properly parsed meta object. Some day we may be able to eliminate that....
 201
 202 ## <a name="ObjectMethod &lt;strong&gt;saveTopic&lt;/strong&gt; ($user,"></a> [[ObjectMethod]] **saveTopic** `($user,$web,$topic,$text,$meta,$options)`
 203
 204 - `$user` - user doing the saving (object)
 205 - `$web` - web for topic
 206 - `$topic` - topic to atach to
 207 - `$text` - topic text
 208 - `$meta` - topic meta-data
 209 - `$options` - Ref to hash of options
 210
 211 `$options` may include:
 212
 213 <table border="1" cellpadding="0" cellspacing="0">
 214   <tr>
 215     <td><code>dontlog</code></td>
 216     <td> don't log this change in twiki log </td>
 217   </tr>
 218   <tr>
 219     <td><code>hide</code></td>
 220     <td> if the attachment is to be hidden in normal topic view </td>
 221   </tr>
 222   <tr>
 223     <td><code>comment</code></td>
 224     <td> comment for save </td>
 225   </tr>
 226   <tr>
 227     <td><code>file</code></td>
 228     <td> Temporary file name to upload </td>
 229   </tr>
 230   <tr>
 231     <td><code>minor</code></td>
 232     <td> True if this is a minor change (used in log) </td>
 233   </tr>
 234   <tr>
 235     <td><code>savecmd</code></td>
 236     <td> Save command </td>
 237   </tr>
 238   <tr>
 239     <td><code>forcedate</code></td>
 240     <td> grr </td>
 241   </tr>
 242   <tr>
 243     <td><code>unlock</code></td>
 244     <td>   </td>
 245   </tr>
 246 </table>
 247
 248 Save a new revision of the topic, calling plugins handlers as appropriate.
 249
 250 ## <a name="ObjectMethod &lt;strong&gt;saveAttachment&lt;/strong&gt; ($"></a> [[ObjectMethod]] **saveAttachment** `($web,$topic,$attachment,$user,$opts)`
 251
 252 - `$user` - user doing the saving
 253 - `$web` - web for topic
 254 - `$topic` - topic to atach to
 255 - `$attachment` - name of the attachment
 256 - `$opts` - Ref to hash of options
 257
 258 `$opts` may include:
 259
 260 <table border="1" cellpadding="0" cellspacing="0">
 261   <tr>
 262     <td><code>dontlog</code></td>
 263     <td> don't log this change in twiki log </td>
 264   </tr>
 265   <tr>
 266     <td><code>comment</code></td>
 267     <td> comment for save </td>
 268   </tr>
 269   <tr>
 270     <td><code>hide</code></td>
 271     <td> if the attachment is to be hidden in normal topic view </td>
 272   </tr>
 273   <tr>
 274     <td><code>stream</code></td>
 275     <td> Stream of file to upload </td>
 276   </tr>
 277   <tr>
 278     <td><code>file</code></td>
 279     <td> Name of a file to use for the attachment data. ignored is stream is set. </td>
 280   </tr>
 281   <tr>
 282     <td><code>filepath</code></td>
 283     <td> Client path to file </td>
 284   </tr>
 285   <tr>
 286     <td><code>filesize</code></td>
 287     <td> Size of uploaded data </td>
 288   </tr>
 289   <tr>
 290     <td><code>filedate</code></td>
 291     <td> Date </td>
 292   </tr>
 293 </table>
 294
 295 Saves a new revision of the attachment, invoking plugin handlers as appropriate.
 296
 297 If file is not set, this is a properties-only save.
 298
 299 ## <a name="ObjectMethod &lt;strong&gt;repRev&lt;/strong&gt; ($user,$we"></a> [[ObjectMethod]] **repRev** `($user,$web,$topic,$text,$meta,$options)`
 300
 301 Replace last (top) revision with different text.
 302
 303 Parameters and return value as saveTopic, except
 304
 305 - `$options` - as for saveTopic, with the extra option:
 306   - `timetravel` - if we want to force the deposited revision to look as much like the revision specified in `$rev` as possible.
 307
 308 Used to try to avoid the deposition of 'unecessary' revisions, for example where a user quickly goes back and fixes a spelling error.
 309
 310 Also provided as a means for administrators to rewrite history (timetravel).
 311
 312 It is up to the store implementation if this is different to a normal save or not.
 313
 314 ## <a name="ObjectMethod &lt;strong&gt;delRev&lt;/strong&gt; ($user,$we"></a> [[ObjectMethod]] **delRev** `($user,$web,$topic,$text,$meta,$options)`
 315
 316 Parameters and return value as saveTopic.
 317
 318 Provided as a means for administrators to rewrite history.
 319
 320 Delete last entry in repository, restoring the previous revision.
 321
 322 It is up to the store implementation whether this actually does delete a revision or not; some implementations will simply promote the previous revision up to the head.
 323
 324 ## <a name="ObjectMethod &lt;strong&gt;lockTopic&lt;/strong&gt; ($web,$"></a> [[ObjectMethod]] **lockTopic** `($web,$topic)`
 325
 326 Grab a topic lock on the given topic. A topic lock will cause other processes that also try to claim a lock to block. A lock has a maximum lifetime of 2 minutes, so operations on a locked topic must be completed within that time. You cannot rely on the lock timeout clearing the lock, though; that should always be done by calling unlockTopic. The best thing to do is to guard the locked section with a try..finally clause. See man Error for more info.
 327
 328 Topic locks are used to make store operations atomic. They are _note_ the locks used when a topic is edited; those are Leases (see `getLease`)
 329
 330 ## <a name="ObjectMethod &lt;strong&gt;unlockTopic&lt;/strong&gt; ($use"></a> [[ObjectMethod]] **unlockTopic** `($user,$web,$topic)`
 331
 332 Release the topic lock on the given topic. A topic lock will cause other processes that also try to claim a lock to block. It is important to release a topic lock after a guard section is complete. This should normally be done in a 'finally' block. See man Error for more info.
 333
 334 Topic locks are used to make store operations atomic. They are _note_ the locks used when a topic is edited; those are Leases (see `getLease`)
 335
 336 ## <a name="ObjectMethod &lt;strong&gt;webExists&lt;/strong&gt; ($web)"></a><a name="ObjectMethod &lt;strong&gt;webExists&lt;/strong&gt; ($web) "></a> [[ObjectMethod]] **webExists** `($web) -> $boolean`
 337
 338 Test if web exists
 339
 340 - `$web` - Web name, required, e.g. `'Sandbox'`
 341
 342 A web _has_ to have a home topic to be a web.
 343
 344 ## <a name="ObjectMethod &lt;strong&gt;topicExists&lt;/strong&gt; ($web"></a> [[ObjectMethod]] **topicExists** `($web,$topic) -> $boolean`
 345
 346 Test if topic exists
 347
 348 - `$web` - Web name, optional, e.g. `'Main'`
 349 - `$topic` - Topic name, required, e.g. `'TokyoOffice'`, or `"Main.TokyoOffice"`
 350
 351 ## <a name="ObjectMethod &lt;strong&gt;get_TopicParent&lt;/strong&gt; ("></a> [[ObjectMethod]] **getTopicParent** `($web,$topic) -> $string`
 352
 353 Get the name of the topic parent. Needs to be fast because of use by Render.pm.
 354
 355 ## <a name="ObjectMethod &lt;strong&gt;get_TopicLatestRev"></a> [[ObjectMethod]] \*getTopicLatestRevTime `($web,$topic) -> $epochSecs`
 356
 357 Get an approximate rev time for the latest rev of the topic. This method is used to optimise searching. Needs to be as fast as possible.
 358
 359 ## <a name="ObjectMethod &lt;strong&gt;read_MetaData&lt;/strong&gt; ($w"></a> [[ObjectMethod]] **readMetaData** `($web,$name) -> $text`
 360
 361 Read a named meta-data string. If web is given the meta-data is stored alongside a web.
 362
 363 ## <a name="ObjectMethod &lt;strong&gt;save_MetaData&lt;/strong&gt; ($w"></a> [[ObjectMethod]] **saveMetaData** `($web,$name) -> $text`
 364
 365 Write a named meta-data string. If web is given the meta-data is stored alongside a web.
 366
 367 ## <a name="ObjectMethod &lt;strong&gt;get_TopicNames&lt;/strong&gt; ($"></a> [[ObjectMethod]] **getTopicNames** `($web) -> @topics`
 368
 369 Get list of all topics in a web
 370
 371 - `$web` - Web name, required, e.g. `'Sandbox'`
 372
 373 Return a topic list, e.g. `( 'WebChanges',  'WebHome', 'WebIndex', 'WebNotify' )`
 374
 375 ## <a name="ObjectMethod &lt;strong&gt;get_ListOfWebs&lt;/strong&gt; ($"></a> [[ObjectMethod]] **getListOfWebs** `($filter) -> @webNames`
 376
 377 Gets a list of webs, filtered according to the spec in the $filter, which may include one of:
 378
 379 1. 'user' (for only user webs)
 380 2. 'template' (for only template webs)
 381
 382 $filter may also contain the word 'public' which will further filter webs on whether NOSEARCHALL is specified for them or not. 'allowed' filters out webs that the user is denied access to by a \*WEBVIEW.
 383
 384 If $TWiki::cfg\{EnableHierarchicalWebs\} is set, will also list sub-webs recursively.
 385
 386 ## <a name="ObjectMethod &lt;strong&gt;createWeb&lt;/strong&gt; ($user,"></a> [[ObjectMethod]] **createWeb** `($user,$newWeb,$baseWeb,$opts)`
 387
 388 $newWeb is the name of the new web.
 389
 390 $baseWeb is the name of an existing web (a template web). If the base web is a system web, all topics in it will be copied into the new web. If it is a normal web, only topics starting with 'Web' will be copied. If no base web is specified, an empty web (with no topics) will be created. If it is specified but does not exist, an error will be thrown.
 391
 392 $opts is a ref to a hash that contains settings to be modified in the web preferences topic in the new web.
 393
 394 ## <a name="ObjectMethod &lt;strong&gt;removeWeb&lt;/strong&gt; ($user,"></a> [[ObjectMethod]] **removeWeb** `($user,$web)`
 395
 396 - `$user` - user doing the removing (for the history)
 397 - `$web` - web being removed
 398
 399 Destroy a web, utterly. Removed the data and attachments in the web.
 400
 401 Use with great care!
 402
 403 The web must be a known web to be removed this way.
 404
 405 ## <a name="ObjectMethod &lt;strong&gt;get_DebugText&lt;/strong&gt; ($m"></a> [[ObjectMethod]] **getDebugText** `($meta,$text) -> $text`
 406
 407 Generate a debug text form of the text/meta, for use in debug displays, by annotating the text with meta informtion.
 408
 409 ## <a name="ObjectMethod &lt;strong&gt;clean_UpRevID&lt;/strong&gt; ($r"></a> [[ObjectMethod]] **cleanUpRevID** `($rev) -> $integer`
 410
 411 Cleans up (maps) a user-supplied revision ID and converts it to an integer number that can be incremented to create a new revision number.
 412
 413 This method should be used to sanitise user-provided revision IDs.
 414
 415 ## <a name="ObjectMethod &lt;strong&gt;copyTopic&lt;/strong&gt; ($user,"></a> [[ObjectMethod]] **copyTopic** `($user,$fromweb,$fromtopic,$toweb,$totopic)`
 416
 417 Copy a topic and all it's attendant data from one web to another.
 418
 419 SMELL: Does not fix up meta-data!
 420
 421 ## <a name="ObjectMethod &lt;strong&gt;search_MetaData&lt;/strong&gt; ("></a> [[ObjectMethod]] **searchMetaData** `($params) -> $text`
 422
 423 Search meta-data associated with topics. Parameters are passed in the $params hash, which may contain:
 424
 425 <table border="1" cellpadding="0" cellspacing="0">
 426   <tr>
 427     <td><code>type</code></td>
 428     <td><code>topicmoved</code>, <code>parent</code> or <code>field</code></td>
 429   </tr>
 430   <tr>
 431     <td><code>topic</code></td>
 432     <td> topic to search for, for <code>topicmoved</code> and <code>parent</code></td>
 433   </tr>
 434   <tr>
 435     <td><code>name</code></td>
 436     <td> form field to search, for <code>field</code> type searches. May be a regex. </td>
 437   </tr>
 438   <tr>
 439     <td><code>value</code></td>
 440     <td> form field value. May be a regex. </td>
 441   </tr>
 442   <tr>
 443     <td><code>title</code></td>
 444     <td> Title prepended to the returned search results </td>
 445   </tr>
 446   <tr>
 447     <td><code>default</code></td>
 448     <td> defualt value if there are no results </td>
 449   </tr>
 450   <tr>
 451     <td><code>web</code></td>
 452     <td> web to search in, default is all webs </td>
 453   </tr>
 454 </table>
 455
 456 The idea is that people can search for meta-data values without having to be aware of how or where meta-data is stored.
 457
 458 SMELL: should be replaced with a proper SQL-like search, c.f. [[DBCacheContrib]].
 459
 460 ## <a name="ObjectMethod &lt;strong&gt;search_InWebConten"></a> [[ObjectMethod]] \*searchInWebContent `($searchString,$web,\@topics,\%options) -> \%map`
 461
 462 Search for a string in the content of a web. The search must be over all content and all formatted meta-data, though the latter search type is deprecated (use searchMetaData instead).
 463
 464 - `$searchString` - the search string, in egrep format if regex
 465 - `$web` - The web to search in
 466 - `\@topics` - reference to a list of topics to search
 467 - `\%options` - reference to an options hash
 468
 469 The `\%options` hash may contain the following options:
 470
 471 - `type` - if `regex` will perform a egrep-syntax RE search (default '')
 472 - `casesensitive` - false to ignore case (defaulkt true)
 473 - `files_without_match` - true to return files only (default false)
 474
 475 The return value is a reference to a hash which maps each matching topic name to a list of the lines in that topic that matched the search, as would be returned by 'grep'. If `files_without_match` is specified, it will return on the first match in each topic (i.e. it will return only one match per topic, and will not return matching lines).
 476
 477 ## <a name="ObjectMethod &lt;strong&gt;get_RevisionAtTime"></a> [[ObjectMethod]] \*getRevisionAtTime `($web,$topic,$time) -> $rev`
 478
 479 - `$web` - web for topic
 480 - `$topic` - topic
 481 - `$time` - time (in epoch secs) for the rev
 482
 483 Get the revision number of a topic at a specific time. Returns a single-digit rev number or undef if it couldn't be determined (either because the topic isn't that old, or there was a problem)
 484
 485 ## <a name="ObjectMethod &lt;strong&gt;getLease&lt;/strong&gt; ($web,$t"></a> [[ObjectMethod]] **getLease** `($web,$topic) -> $lease`
 486
 487 - `$web` - web for topic
 488 - `$topic` - topic
 489
 490 If there is an lease on the topic, return the lease, otherwise undef. A lease is a block of meta-information about a topic that can be recovered (this is a hash containing `user`, `taken` and `expires`). Leases are taken out when a topic is edited. Only one lease can be active on a topic at a time. Leases are used to warn if another user is already editing a topic.
 491
 492 ## <a name="ObjectMethod &lt;strong&gt;setLease&lt;/strong&gt; ($web,$t"></a> [[ObjectMethod]] **setLease** `($web,$topic,$user,$length)`
 493
 494 Take out an lease on the given topic for this user for $length seconds.
 495
 496 See `getLease` for more details about Leases.
 497
 498 ## <a name="ObjectMethod &lt;strong&gt;clearLease&lt;/strong&gt; ($web,"></a> [[ObjectMethod]] **clearLease** `($web,$topic)`
 499
 500 Cancel the current lease.
 501
 502 See `getLease` for more details about Leases.