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>($user,$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** `($user,$web,$topic,$rev1,$rev2,$contextLines) -> \@diffArray`
 147
 148 Return reference to an array of [ diffType, $right, $left ]
 149
 150 - `$user` - the user object, or undef to suppress access control checks
 151 - `$web` - the web
 152 - `$topic` - the topic
 153 - `$rev1` Integer revision number
 154 - `$rev2` Integer revision number
 155 - `$contextLines` - number of lines of context required
 156
 157 ## <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)`
 158
 159 Get revision info of a topic.
 160
 161 - `$web` Web name, optional, e.g. `'Main'`
 162 - `$topic` Topic name, required, e.g. `'TokyoOffice'`
 163 - `$rev` revision number. If 0, undef, or out-of-range, will get info about the most recent revision.
 164 - `$attachment` attachment filename; undef for a topic
 165
 166 Return list with: ( last update date, last user object, =
 167
 168 <table border="1" cellpadding="0" cellspacing="0">
 169   <tr>
 170     <td> $date </td>
 171     <td> in epochSec </td>
 172   </tr>
 173   <tr>
 174     <td> $user </td>
 175     <td> user <strong>object</strong></td>
 176   </tr>
 177   <tr>
 178     <td> $rev </td>
 179     <td> the revision number </td>
 180   </tr>
 181   <tr>
 182     <td> $comment </td>
 183     <td> WHAT COMMENT? </td>
 184   </tr>
 185 </table>
 186
 187 e.g. =( 1234561, 'phoeny', 5, 'no comment' )
 188
 189 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)
 190
 191 ## <a name="StaticMethod &lt;strong&gt;dataEncode&lt;/strong&gt; ($unco"></a> [[StaticMethod]] **dataEncode** `($uncoded) -> $coded`
 192
 193 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.
 194
 195 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....
 196
 197 ## <a name="StaticMethod &lt;strong&gt;dataDecode&lt;/strong&gt; ($enco"></a> [[StaticMethod]] **dataDecode** `($encoded) -> $decoded`
 198
 199 Decode escapes in a string that was encoded using dataEncode
 200
 201 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....
 202
 203 ## <a name="ObjectMethod &lt;strong&gt;saveTopic&lt;/strong&gt; ($user,"></a> [[ObjectMethod]] **saveTopic** `($user,$web,$topic,$text,$meta,$options)`
 204
 205 - `$user` - user doing the saving (object)
 206 - `$web` - web for topic
 207 - `$topic` - topic to atach to
 208 - `$text` - topic text
 209 - `$meta` - topic meta-data
 210 - `$options` - Ref to hash of options
 211
 212 `$options` may include:
 213
 214 <table border="1" cellpadding="0" cellspacing="0">
 215   <tr>
 216     <td><code>dontlog</code></td>
 217     <td> don't log this change in twiki log </td>
 218   </tr>
 219   <tr>
 220     <td><code>hide</code></td>
 221     <td> if the attachment is to be hidden in normal topic view </td>
 222   </tr>
 223   <tr>
 224     <td><code>comment</code></td>
 225     <td> comment for save </td>
 226   </tr>
 227   <tr>
 228     <td><code>file</code></td>
 229     <td> Temporary file name to upload </td>
 230   </tr>
 231   <tr>
 232     <td><code>minor</code></td>
 233     <td> True if this is a minor change (used in log) </td>
 234   </tr>
 235   <tr>
 236     <td><code>savecmd</code></td>
 237     <td> Save command </td>
 238   </tr>
 239   <tr>
 240     <td><code>forcedate</code></td>
 241     <td> grr </td>
 242   </tr>
 243   <tr>
 244     <td><code>unlock</code></td>
 245     <td>   </td>
 246   </tr>
 247 </table>
 248
 249 Save a new revision of the topic, calling plugins handlers as appropriate.
 250
 251 ## <a name="ObjectMethod &lt;strong&gt;saveAttachment&lt;/strong&gt; ($"></a> [[ObjectMethod]] **saveAttachment** `($web,$topic,$attachment,$user,$opts)`
 252
 253 - `$user` - user doing the saving
 254 - `$web` - web for topic
 255 - `$topic` - topic to atach to
 256 - `$attachment` - name of the attachment
 257 - `$opts` - Ref to hash of options
 258
 259 `$opts` may include:
 260
 261 <table border="1" cellpadding="0" cellspacing="0">
 262   <tr>
 263     <td><code>dontlog</code></td>
 264     <td> don't log this change in twiki log </td>
 265   </tr>
 266   <tr>
 267     <td><code>comment</code></td>
 268     <td> comment for save </td>
 269   </tr>
 270   <tr>
 271     <td><code>hide</code></td>
 272     <td> if the attachment is to be hidden in normal topic view </td>
 273   </tr>
 274   <tr>
 275     <td><code>stream</code></td>
 276     <td> Stream of file to upload </td>
 277   </tr>
 278   <tr>
 279     <td><code>file</code></td>
 280     <td> Name of a file to use for the attachment data. ignored is stream is set. </td>
 281   </tr>
 282   <tr>
 283     <td><code>filepath</code></td>
 284     <td> Client path to file </td>
 285   </tr>
 286   <tr>
 287     <td><code>filesize</code></td>
 288     <td> Size of uploaded data </td>
 289   </tr>
 290   <tr>
 291     <td><code>filedate</code></td>
 292     <td> Date </td>
 293   </tr>
 294 </table>
 295
 296 Saves a new revision of the attachment, invoking plugin handlers as appropriate.
 297
 298 If file is not set, this is a properties-only save.
 299
 300 ## <a name="ObjectMethod &lt;strong&gt;repRev&lt;/strong&gt; ($user,$we"></a> [[ObjectMethod]] **repRev** `($user,$web,$topic,$text,$meta,$options)`
 301
 302 Replace last (top) revision with different text.
 303
 304 Parameters and return value as saveTopic, except
 305
 306 - `$options` - as for saveTopic, with the extra option:
 307   - `timetravel` - if we want to force the deposited revision to look as much like the revision specified in `$rev` as possible.
 308
 309 Used to try to avoid the deposition of 'unecessary' revisions, for example where a user quickly goes back and fixes a spelling error.
 310
 311 Also provided as a means for administrators to rewrite history (timetravel).
 312
 313 It is up to the store implementation if this is different to a normal save or not.
 314
 315 ## <a name="ObjectMethod &lt;strong&gt;delRev&lt;/strong&gt; ($user,$we"></a> [[ObjectMethod]] **delRev** `($user,$web,$topic,$text,$meta,$options)`
 316
 317 Parameters and return value as saveTopic.
 318
 319 Provided as a means for administrators to rewrite history.
 320
 321 Delete last entry in repository, restoring the previous revision.
 322
 323 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.
 324
 325 ## <a name="ObjectMethod &lt;strong&gt;lockTopic&lt;/strong&gt; ($web,$"></a> [[ObjectMethod]] **lockTopic** `($web,$topic)`
 326
 327 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.
 328
 329 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`)
 330
 331 ## <a name="ObjectMethod &lt;strong&gt;unlockTopic&lt;/strong&gt; ($use"></a> [[ObjectMethod]] **unlockTopic** `($user,$web,$topic)`
 332
 333 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.
 334
 335 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`)
 336
 337 ## <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`
 338
 339 Test if web exists
 340
 341 - `$web` - Web name, required, e.g. `'Sandbox'`
 342
 343 A web _has_ to have a home topic to be a web.
 344
 345 ## <a name="ObjectMethod &lt;strong&gt;topicExists&lt;/strong&gt; ($web"></a> [[ObjectMethod]] **topicExists** `($web,$topic) -> $boolean`
 346
 347 Test if topic exists
 348
 349 - `$web` - Web name, optional, e.g. `'Main'`
 350 - `$topic` - Topic name, required, e.g. `'TokyoOffice'`, or `"Main.TokyoOffice"`
 351
 352 ## <a name="ObjectMethod &lt;strong&gt;get_TopicParent&lt;/strong&gt; ("></a> [[ObjectMethod]] **getTopicParent** `($web,$topic) -> $string`
 353
 354 Get the name of the topic parent. Needs to be fast because of use by Render.pm.
 355
 356 ## <a name="ObjectMethod &lt;strong&gt;get_TopicLatestRev"></a> [[ObjectMethod]] \*getTopicLatestRevTime `($web,$topic) -> $epochSecs`
 357
 358 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.
 359
 360 ## <a name="ObjectMethod &lt;strong&gt;read_MetaData&lt;/strong&gt; ($w"></a> [[ObjectMethod]] **readMetaData** `($web,$name) -> $text`
 361
 362 Read a named meta-data string. If web is given the meta-data is stored alongside a web.
 363
 364 ## <a name="ObjectMethod &lt;strong&gt;save_MetaData&lt;/strong&gt; ($w"></a> [[ObjectMethod]] **saveMetaData** `($web,$name) -> $text`
 365
 366 Write a named meta-data string. If web is given the meta-data is stored alongside a web.
 367
 368 ## <a name="ObjectMethod &lt;strong&gt;get_TopicNames&lt;/strong&gt; ($"></a> [[ObjectMethod]] **getTopicNames** `($web) -> @topics`
 369
 370 Get list of all topics in a web
 371
 372 - `$web` - Web name, required, e.g. `'Sandbox'`
 373
 374 Return a topic list, e.g. `( 'WebChanges',  'WebHome', 'WebIndex', 'WebNotify' )`
 375
 376 ## <a name="ObjectMethod &lt;strong&gt;get_ListOfWebs&lt;/strong&gt; ($"></a> [[ObjectMethod]] **getListOfWebs** `($filter) -> @webNames`
 377
 378 Gets a list of webs, filtered according to the spec in the $filter, which may include one of:
 379
 380 1. 'user' (for only user webs)
 381 2. 'template' (for only template webs)
 382
 383 $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.
 384
 385 If $TWiki::cfg\{EnableHierarchicalWebs\} is set, will also list sub-webs recursively.
 386
 387 ## <a name="ObjectMethod &lt;strong&gt;createWeb&lt;/strong&gt; ($user,"></a> [[ObjectMethod]] **createWeb** `($user,$newWeb,$baseWeb,$opts)`
 388
 389 $newWeb is the name of the new web.
 390
 391 $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.
 392
 393 $opts is a ref to a hash that contains settings to be modified in the web preferences topic in the new web.
 394
 395 ## <a name="ObjectMethod &lt;strong&gt;removeWeb&lt;/strong&gt; ($user,"></a> [[ObjectMethod]] **removeWeb** `($user,$web)`
 396
 397 - `$user` - user doing the removing (for the history)
 398 - `$web` - web being removed
 399
 400 Destroy a web, utterly. Removed the data and attachments in the web.
 401
 402 Use with great care!
 403
 404 The web must be a known web to be removed this way.
 405
 406 ## <a name="ObjectMethod &lt;strong&gt;get_DebugText&lt;/strong&gt; ($m"></a> [[ObjectMethod]] **getDebugText** `($meta,$text) -> $text`
 407
 408 Generate a debug text form of the text/meta, for use in debug displays, by annotating the text with meta informtion.
 409
 410 ## <a name="ObjectMethod &lt;strong&gt;clean_UpRevID&lt;/strong&gt; ($r"></a> [[ObjectMethod]] **cleanUpRevID** `($rev) -> $integer`
 411
 412 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.
 413
 414 This method should be used to sanitise user-provided revision IDs.
 415
 416 ## <a name="ObjectMethod &lt;strong&gt;copyTopic&lt;/strong&gt; ($user,"></a> [[ObjectMethod]] **copyTopic** `($user,$fromweb,$fromtopic,$toweb,$totopic)`
 417
 418 Copy a topic and all it's attendant data from one web to another.
 419
 420 SMELL: Does not fix up meta-data!
 421
 422 ## <a name="ObjectMethod &lt;strong&gt;search_MetaData&lt;/strong&gt; ("></a> [[ObjectMethod]] **searchMetaData** `($params) -> $text`
 423
 424 Search meta-data associated with topics. Parameters are passed in the $params hash, which may contain:
 425
 426 <table border="1" cellpadding="0" cellspacing="0">
 427   <tr>
 428     <td><code>type</code></td>
 429     <td><code>topicmoved</code>, <code>parent</code> or <code>field</code></td>
 430   </tr>
 431   <tr>
 432     <td><code>topic</code></td>
 433     <td> topic to search for, for <code>topicmoved</code> and <code>parent</code></td>
 434   </tr>
 435   <tr>
 436     <td><code>name</code></td>
 437     <td> form field to search, for <code>field</code> type searches. May be a regex. </td>
 438   </tr>
 439   <tr>
 440     <td><code>value</code></td>
 441     <td> form field value. May be a regex. </td>
 442   </tr>
 443   <tr>
 444     <td><code>title</code></td>
 445     <td> Title prepended to the returned search results </td>
 446   </tr>
 447   <tr>
 448     <td><code>default</code></td>
 449     <td> defualt value if there are no results </td>
 450   </tr>
 451   <tr>
 452     <td><code>web</code></td>
 453     <td> web to search in, default is all webs </td>
 454   </tr>
 455 </table>
 456
 457 The idea is that people can search for meta-data values without having to be aware of how or where meta-data is stored.
 458
 459 SMELL: should be replaced with a proper SQL-like search, c.f. [[DBCacheContrib]].
 460
 461 ## <a name="ObjectMethod &lt;strong&gt;search_InWebConten"></a> [[ObjectMethod]] \*searchInWebContent `($searchString,$web,\@topics,\%options) -> \%map`
 462
 463 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).
 464
 465 - `$searchString` - the search string, in egrep format if regex
 466 - `$web` - The web to search in
 467 - `\@topics` - reference to a list of topics to search
 468 - `\%options` - reference to an options hash
 469
 470 The `\%options` hash may contain the following options:
 471
 472 - `type` - if `regex` will perform a egrep-syntax RE search (default '')
 473 - `casesensitive` - false to ignore case (defaulkt true)
 474 - `files_without_match` - true to return files only (default false)
 475
 476 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).
 477
 478 ## <a name="ObjectMethod &lt;strong&gt;get_RevisionAtTime"></a> [[ObjectMethod]] \*getRevisionAtTime `($web,$topic,$time) -> $rev`
 479
 480 - `$web` - web for topic
 481 - `$topic` - topic
 482 - `$time` - time (in epoch secs) for the rev
 483
 484 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)
 485
 486 ## <a name="ObjectMethod &lt;strong&gt;getLease&lt;/strong&gt; ($web,$t"></a> [[ObjectMethod]] **getLease** `($web,$topic) -> $lease`
 487
 488 - `$web` - web for topic
 489 - `$topic` - topic
 490
 491 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.
 492
 493 ## <a name="ObjectMethod &lt;strong&gt;setLease&lt;/strong&gt; ($web,$t"></a> [[ObjectMethod]] **setLease** `($web,$topic,$user,$length)`
 494
 495 Take out an lease on the given topic for this user for $length seconds.
 496
 497 See `getLease` for more details about Leases.
 498
 499 ## <a name="ObjectMethod &lt;strong&gt;clearLease&lt;/strong&gt; ($web,"></a> [[ObjectMethod]] **clearLease** `($web,$topic)`
 500
 501 Cancel the current lease.
 502
 503 See `getLease` for more details about Leases.