subversion/bindings/swig/perl/native/Fs.pm

   1 use strict;
   2 use warnings;
   3
   4 package SVN::Fs;
   5 use SVN::Base qw(Fs svn_fs_);
   6
   7 =head1 NAME
   8
   9 SVN::Fs - Subversion filesystem functions
  10
  11 =head1 DESCRIPTION
  12
  13 SVN::Fs wraps the functions in svn_fs.h.  The actual namespace
  14 for filesystem objects is C<_p_svn_fs_t>.
  15
  16 =head1 FUNCTIONS
  17
  18 =over
  19
  20 =item SVN::Fs::berkeley_logfiles($path, $only_unused)
  21
  22 =item SVN::Fs::berkeley_recover($path)
  23
  24 =item SVN::Fs::check_related($id1, $id2)
  25
  26 =item SVN::Fs::compare_ids($id1, $id2)
  27
  28 =item SVN::Fs::contents_changed($root1, $path1, $root2, $path2)
  29
  30 =item SVN::Fs::create($path, $config)
  31
  32 =item SVN::Fs::delete_fs($path)
  33
  34 =item SVN::Fs::deltify_revision($fs, $rev)
  35
  36 =item SVN::Fs::get_file_delta_stream($source_root, $source_path, $target_root, $target_path)
  37
  38 =item SVN::Fs::hotcopy($src_path, $dest_path, $clean)
  39
  40 =item SVN::Fs::initialize($pool)
  41
  42 =item SVN::Fs::merge($source_root, $source_path, $target_root, $target_path, $ancestor_root, $ancestor_path)
  43
  44 =item SVN::Fs::open($path, $config)
  45
  46 =item SVN::Fs::path($fs)
  47
  48 =item SVN::Fs::print_modules($s)
  49
  50 TODO - doesn't work, segfaults if $s is null, doesn't do anything if
  51 its an empty string
  52
  53 =item SVN::Fs::props_changed($root1, $path1, $root2, $path2)
  54
  55 See also C<SVN::Fs::contents_changed>
  56
  57 =item SVN::Fs::purge_txn($fs, $txn_id)
  58
  59 Cleanup the transaction C<$txn_id>, removing it completely from
  60 the filesystem C<$fs>.
  61
  62 =item SVN::Fs::set_warning_func($fs, $code, $baton)
  63
  64 =item SVN::Fs::unparse_id($id)
  65
  66 Return a string containing the unparsed form of the node or node
  67 revision id $id, which must be a C<_p_svn_fs_id_t> object.
  68
  69 TODO - why isn't this a method of that object?
  70
  71 =item SVN::Fs::version()
  72
  73 TODO - what can we do with the _p_svn_version_t value returned?
  74
  75 =item SVN::Fs::create_access($username)
  76
  77 Return a new C<_p_svn_fs_access_t> object representing C<$username>.
  78 C<$username> is presumed to have been authenticated by the caller.
  79
  80 =back
  81
  82 =cut
  83
  84 package _p_svn_fs_t;
  85
  86 =head1 _p_svn_fs_t
  87
  88 =over
  89
  90 =item $fs-E<gt>begin_txn($rev)
  91
  92 Creates a new transaction in the repository, and returns a
  93 C<_p_svn_fs_txn_t> object representing it.  The new transaction's
  94 base revision will be $rev, which should be a number.
  95
  96 =item $fs-E<gt>change_rev_prop
  97
  98 =item $fs-E<gt>generate_lock_token()
  99
 100 Generate a unique lock-token using C<$fs>.
 101
 102 TODO - translate this to apply to Perl:
 103 This can be used in to populate lock->token before calling
 104 svn_fs_attach_lock().
 105
 106 =item $fs-E<gt>get_access()
 107
 108 The filesystem's current access context, as a C<_p_svn_fs_access_t>
 109 object.  Returns undef if no access context has been set with
 110 the C<set_access()> method.
 111
 112 =item $fs-E<gt>get_lock
 113
 114 =item $fs-E<gt>get_locks
 115
 116 =item $fs-E<gt>get_uuid()
 117
 118 The UUID associated with C<$fs>.
 119
 120 =item $fs-E<gt>list_transactions()
 121
 122 A reference to an array of all currently active transactions in the
 123 filesystem.  Each one is a string containing the transaction's ID,
 124 suitable for passing to C<$fs-E<gt>open_txn()>.
 125
 126 =item $fs-E<gt>lock
 127
 128 =item $fs-E<gt>open_txn($name)
 129
 130 Get a transaction in the repository by name.  Returns a
 131 C<_p_svn_fs_txn_t> object.
 132
 133 =item $fs-E<gt>revision_prop($rev, $propname)
 134
 135 The value of revision property C<$propname> in revision C<$rev>.
 136
 137 =item $fs-E<gt>revision_proplist($rev)
 138
 139 A hashref containing the names and values of all revision properties
 140 from revision C<$rev>.
 141
 142 =item $fs-E<gt>revision_root
 143
 144 =item $fs-E<gt>set_access($access)
 145
 146 Associate an access context with an open filesystem.
 147
 148 This method can be run multiple times on the same open
 149 filesystem, in order to change the filesystem access context for
 150 different filesystem operations.  C<$access> should be
 151 a C<_p_svn_fs_access_t> object, or undef to disassociate the
 152 current access context from the filesystem.
 153
 154 =item $fs-E<gt>set_uuid($uuid)
 155
 156 Associate C<$uuid> with C<$fs>.
 157
 158 =item $fs-E<gt>unlock
 159
 160 =item $fs-E<gt>youngest_rev()
 161
 162 Return the number of the youngest revision in the filesystem.
 163 The oldest revision in any filesystem is numbered zero.
 164
 165 =back
 166
 167 =cut
 168
 169 our @methods = qw/youngest_rev revision_root revision_prop revision_proplist
 170                   change_rev_prop list_transactions open_txn begin_txn
 171                   get_uuid set_uuid set_access get_access
 172                   lock unlock get_lock get_locks generate_lock_token path/;
 173
 174 for (@methods) {
 175     no strict 'refs';
 176     *{$_} = *{"SVN::Fs::$_"};
 177 }
 178
 179 package _p_svn_fs_root_t;
 180
 181 =head1 _p_svn_fs_root_t
 182
 183 =over
 184
 185 =item $root-E<gt>apply_text
 186
 187 =item $root-E<gt>apply_textdelta
 188
 189 =item $root-E<gt>change_node_prop($path, $propname, $value)
 190
 191 =item $root-E<gt>check_path($path)
 192
 193 Kind of node at C<$path>.  A number which matches one of these constants:
 194 $SVN::Node::none, $SVN::Node::file,
 195 $SVN::Node::dir, $SVN::Node::unknown.
 196
 197 =item $root-E<gt>close_root
 198
 199 =item $root-E<gt>closest_copy
 200
 201 =item $root-E<gt>copied_from
 202
 203 =item $root-E<gt>copy
 204
 205 =item $root-E<gt>delete
 206
 207 =item $root-E<gt>dir_entries
 208
 209 =item $root-E<gt>file_contents
 210
 211 =item $root-E<gt>file_length
 212
 213 =item $root-E<gt>file_md5_checksum
 214
 215 =item $root-E<gt>fs()
 216
 217 The filesystem to which C<$root> belongs, as a C<_p_svn_fs_t> object.
 218
 219 =item $root-E<gt>is_dir($path)
 220
 221 True if there is a node at C<$path> which is a directory.
 222
 223 =item $root-E<gt>is_file($path)
 224
 225 True if there is a node at C<$path> which is a file.
 226
 227 =item $root-E<gt>is_revision_root()
 228
 229 True if the root comes from a revision (i.e., the contents has already been
 230 committed).
 231
 232 =item $root-E<gt>is_txn_root()
 233
 234 True if the root comes from a transaction.
 235
 236 =item $root-E<gt>make_dir
 237
 238 =item $root-E<gt>make_file
 239
 240 =item $root-E<gt>node_created_path($path)
 241
 242 =item $root-E<gt>node_created_rev($path)
 243
 244 =item $root-E<gt>node_history($path)
 245
 246 TODO - _p_svn_fs_history_t
 247
 248 =item $root-E<gt>node_id($path)
 249
 250 =item $root-E<gt>node_prop($path, $propname)
 251
 252 =item $root-E<gt>node_proplist($path)
 253
 254 =item $root-E<gt>paths_changed()
 255
 256 A reference to a hash indicating what changes are made in the root.
 257 The keys are the paths of the files changed, starting with C</> to
 258 indicate the top-level directory of the repository.  The values
 259 are C<_p_svn_fs_path_change_t> objects which contain information about
 260 what kind of changes are made.
 261
 262 =item $root-E<gt>revision_link
 263
 264 =item $root-E<gt>revision_root_revision
 265
 266 Revision number of the revision the root comes from.
 267 For transaction roots, returns C<$SVN::Core::INVALID_REVNUM>.
 268
 269 =back
 270
 271 =cut
 272
 273 our @methods = qw/apply_textdelta apply_text change_node_prop
 274                  check_path close_root copied_from copy
 275                  dir_entries delete file_contents closest_copy
 276                  file_length file_md5_checksum is_dir is_file
 277                  is_revision_root is_txn_root make_dir make_file
 278                  node_created_rev node_history node_id node_prop
 279                  node_proplist paths_changed revision_link
 280                  revision_root_revision/;
 281
 282 *fs = *SVN::Fs::root_fs;
 283 *txn_name = *_p_svn_fs_txn_t::root_name;
 284
 285 for (@methods) {
 286     no strict 'refs';
 287     *{$_} = *{"SVN::Fs::$_"};
 288 }
 289
 290 package _p_svn_fs_history_t;
 291 use SVN::Base qw(Fs svn_fs_history_);
 292
 293 =head1 _p_svn_fs_history_t
 294
 295 =over
 296
 297 =item $history-E<gt>location()
 298
 299 In list context, a list of two items: the path to the node whose history
 300 this is, and the revision number in which it exists.  In scalar context
 301 returns only the revision number.
 302
 303 =item $history-E<gt>prev($cross_copies)
 304
 305 =back
 306
 307 =cut
 308
 309 package _p_svn_fs_txn_t;
 310 use SVN::Base qw(Fs svn_fs_txn_);
 311
 312 =head1 _p_svn_fs_txn_t
 313
 314 =over
 315
 316 =item $txn-E<gt>abort()
 317
 318 Abort the transaction.  Any changes made in C<$txn> are discarded, and
 319 the filesystem is left unchanged.
 320
 321 Note: This function first sets the state of C<$txn> to 'dead', and
 322 then attempts to purge it and any related data from the filesystem.
 323 If some part of the cleanup process fails, C<$txn> and some portion
 324 of its data may remain in the database after this function returns.
 325 Use C<$fs-E<gt>purge_txn()> to retry the transaction cleanup.
 326
 327 =item $txn-E<gt>base_revision()
 328
 329 The transaction's base revision number.
 330
 331 =item $txn-E<gt>change_prop($name, $value)
 332
 333 Add, change, or remove a property from the transaction.
 334 If C<$value> is C<undef> then the property C<$name> is removed,
 335 if it exists.  Otherwise the property C<$name> is set to the
 336 new value.
 337
 338 =item $txn-E<gt>commit
 339
 340 =item $txn-E<gt>name()
 341
 342 Full name of the revision, in the same format as can be passed
 343 to C<$fs-E<gt>open_txn()>.
 344
 345 =item $txn-E<gt>prop($name)
 346
 347 The value of the transaction's C<$name> property.
 348
 349 =item $txn-E<gt>proplist()
 350
 351 A reference to a hash containing all the transaction's properties,
 352 keyed by name.
 353
 354 =item $txn-E<gt>root()
 355
 356 The root directory of the transaction, as a C<_p_svn_fs_root_t> object.
 357
 358 =back
 359
 360 =cut
 361
 362 *commit = *SVN::Fs::commit_txn;
 363 *abort = *SVN::Fs::abort_txn;
 364 *change_prop = *SVN::Fs::change_txn_prop;
 365
 366 package _p_svn_fs_access_t;
 367 use SVN::Base qw(Fs svn_fs_access_);
 368
 369 =head1 _p_svn_fs_access_t
 370
 371 =head2 SYNOPSIS
 372
 373     my $access = SVN::Fs::create_access($username);
 374
 375     my $access = $fs->get_access;
 376     $fs->set_access($access);
 377
 378     my $username = $access->get_username;
 379
 380     $access->add_lock_token($token);
 381
 382 =head2 METHODS
 383
 384 =over
 385
 386 =item $access-E<gt>add_lock_token($token)
 387
 388 Push a lock-token into the access context.  The
 389 context remembers all tokens it receives, and makes them available
 390 to fs functions.
 391
 392 =item $access-E<gt>get_username
 393
 394 The username represented by the access context.
 395
 396 =back
 397
 398 =cut
 399
 400 package _p_svn_fs_dirent_t;
 401 use SVN::Base qw(Fs svn_fs_dirent_t_);
 402
 403 =head1 svn_fs_dirent_t
 404
 405 An object representing a directory entry.  Values of this type are returned
 406 as the values in the hash returned by C<$root-E<gt>dir_entries()>.  They
 407 are like L<svn_dirent_t|SVN::Core/svn_dirent_t> objects, but have less
 408 information.
 409
 410 =over
 411
 412 =item $dirent-E<gt>id()
 413
 414 TODO
 415
 416 =item $dirent-E<gt>kind()
 417
 418 Node kind.  A number which matches one of these constants:
 419 $SVN::Node::none, $SVN::Node::file,
 420 $SVN::Node::dir, $SVN::Node::unknown.
 421
 422 =item $dirent-E<gt>name()
 423
 424 The filename of the directory entry.
 425
 426 =back
 427
 428 =cut
 429
 430 package _p_svn_fs_path_change_t;
 431 use SVN::Base qw(Fs svn_fs_path_change_t_);
 432
 433 =head1 _p_svn_fs_path_change_t
 434
 435 =over
 436
 437 =item $change-E<gt>change_kind()
 438
 439 The type of change made.  A number which matches one of the following:
 440
 441 =over
 442
 443 =item $SVN::Fs::PathChange::modify
 444
 445 Content at path modified.
 446
 447 =item $SVN::Fs::PathChange::add
 448
 449 Path added in transaction.
 450
 451 =item $SVN::Fs::PathChange::delete
 452
 453 Path removed in transaction.
 454
 455 =item $SVN::Fs::PathChange::replace
 456
 457 Path removed and re-added in transaction.
 458
 459 =item $SVN::Fs::PathChange::reset
 460
 461 Ignore all previous change items for path (internal-use only).
 462
 463 =back
 464
 465 =item $change-E<gt>node_rev_id()
 466
 467 Node revision id of changed path.  A C<_p_svn_fs_id_t> object.
 468
 469 =item $change-E<gt>prop_mod()
 470
 471 True if the properties were modified.
 472
 473 =item $change-E<gt>text_mod()
 474
 475 True if the text (content) was modified.
 476
 477 =back
 478
 479 =cut
 480
 481 package SVN::Fs::PathChange;
 482 use SVN::Base qw(Fs svn_fs_path_change_);
 483
 484 1;