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