Class: FileUtils::Entry_

Inherits:
Object
  • Object
show all
Includes:
StreamUtils_
Defined in:
lib/fileutils.rb

Overview

:nodoc: internal use only

Constant Summary collapse

S_IF_DOOR = 
0xD000

Instance Method Summary collapse

Constructor Details

#initialize(a, b = nil, deref = false) ⇒ Entry_

Returns a new instance of Entry_.



1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
 
# File 'lib/fileutils.rb', line 1217

def initialize(a, b = nil, deref = false)
  @prefix = @rel = @path = nil
  if b
    @prefix = a
    @rel = b
  else
    @path = a
  end
  @deref = deref
  @stat = nil
  @lstat = nil
end

Instance Method Details

#blockdev? ⇒ Boolean

Returns:

  • (Boolean) 


1278
1279
1280
1281
 
# File 'lib/fileutils.rb', line 1278

def blockdev?
  s = lstat!
  s and s.blockdev?
end

#chardev? ⇒ Boolean

Returns:

  • (Boolean) 


1273
1274
1275
1276
 
# File 'lib/fileutils.rb', line 1273

def chardev?
  s = lstat!
  s and s.chardev?
end

#chmod(mode) ⇒ Object 



1344
1345
1346
1347
1348
1349
1350
 
# File 'lib/fileutils.rb', line 1344

def chmod(mode)
  if symlink?
    File.lchmod mode, path() if have_lchmod?
  else
    File.chmod mode, path()
  end
end

#chown(uid, gid) ⇒ Object 



1352
1353
1354
1355
1356
1357
1358
 
# File 'lib/fileutils.rb', line 1352

def chown(uid, gid)
  if symlink?
    File.lchown uid, gid, path() if have_lchown?
  else
    File.chown uid, gid, path()
  end
end

#copy(dest) ⇒ Object 



1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
 
# File 'lib/fileutils.rb', line 1360

def copy(dest)
  case
  when file?
    copy_file dest
  when directory?
    if !File.exist?(dest) and descendant_diretory?(dest, path)
      raise ArgumentError, "cannot copy directory %s to itself %s" % [path, dest]
    end
    begin
      Dir.mkdir dest
    rescue
      raise unless File.directory?(dest)
    end
  when symlink?
    File.symlink File.readlink(path()), dest
  when chardev?
    raise "cannot handle device file" unless File.respond_to?(:mknod)
    mknod dest, ?c, 0666, lstat().rdev
  when blockdev?
    raise "cannot handle device file" unless File.respond_to?(:mknod)
    mknod dest, ?b, 0666, lstat().rdev
  when socket?
    raise "cannot handle socket" unless File.respond_to?(:mknod)
    mknod dest, nil, lstat().mode, 0
  when pipe?
    raise "cannot handle FIFO" unless File.respond_to?(:mkfifo)
    mkfifo dest, 0666
  when door?
    raise "cannot handle door: #{path()}"
  else
    raise "unknown file type: #{path()}"
  end
end

#copy_file(dest) ⇒ Object 



1394
1395
1396
1397
1398
1399
1400
 
# File 'lib/fileutils.rb', line 1394

def copy_file(dest)
  File.open(path()) do |s|
    File.open(dest, 'wb', s.stat.mode) do |f|
      IO.copy_stream(s, f)
    end
  end
end

#copy_metadata(path) ⇒ Object 



1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
 
# File 'lib/fileutils.rb', line 1402

def copy_metadata(path)
  st = lstat()
  if !st.symlink?
    File.utime st.atime, st.mtime, path
  end
  begin
    if st.symlink?
      begin
        File.lchown st.uid, st.gid, path
      rescue NotImplementedError
      end
    else
      File.chown st.uid, st.gid, path
    end
  rescue Errno::EPERM
    # clear setuid/setgid
    if st.symlink?
      begin
        File.lchmod st.mode & 01777, path
      rescue NotImplementedError
      end
    else
      File.chmod st.mode & 01777, path
    end
  else
    if st.symlink?
      begin
        File.lchmod st.mode, path
      rescue NotImplementedError
      end
    else
      File.chmod st.mode, path
    end
  end
end

#dereference? ⇒ Boolean

Returns:

  • (Boolean) 


1250
1251
1252
 
# File 'lib/fileutils.rb', line 1250

def dereference?
  @deref
end

#directory? ⇒ Boolean

Returns:

  • (Boolean) 


1263
1264
1265
1266
 
# File 'lib/fileutils.rb', line 1263

def directory?
  s = lstat!
  s and s.directory?
end

#door? ⇒ Boolean

Returns:

  • (Boolean) 


1295
1296
1297
1298
 
# File 'lib/fileutils.rb', line 1295

def door?
  s = lstat!
  s and (s.mode & 0xF000 == S_IF_DOOR)
end

#entries ⇒ Object 



1300
1301
1302
1303
1304
1305
1306
 
# File 'lib/fileutils.rb', line 1300

def entries
  opts = {}
  opts[:encoding] = ::Encoding::UTF_8 if fu_windows?
  Dir.entries(path(), opts)\
      .reject {|n| n == '.' or n == '..' }\
      .map {|n| Entry_.new(prefix(), join(rel(), n.untaint)) }
end

#exist? ⇒ Boolean

Returns:

  • (Boolean) 


1254
1255
1256
 
# File 'lib/fileutils.rb', line 1254

def exist?
  lstat! ? true : false
end

#file? ⇒ Boolean

Returns:

  • (Boolean) 


1258
1259
1260
1261
 
# File 'lib/fileutils.rb', line 1258

def file?
  s = lstat!
  s and s.file?
end

#inspect ⇒ Object 



1230
1231
1232
 
# File 'lib/fileutils.rb', line 1230

def inspect
  "\#<#{self.class} #{path()}>"
end

#lstat ⇒ Object 



1330
1331
1332
1333
1334
1335
1336
 
# File 'lib/fileutils.rb', line 1330

def lstat
  if dereference?
    @lstat ||= File.stat(path())
  else
    @lstat ||= File.lstat(path())
  end
end

#lstat! ⇒ Object 



1338
1339
1340
1341
1342
 
# File 'lib/fileutils.rb', line 1338

def lstat!
  lstat()
rescue SystemCallError
  nil
end

#path ⇒ Object 



1234
1235
1236
1237
1238
1239
1240
 
# File 'lib/fileutils.rb', line 1234

def path
  if @path
    File.path(@path)
  else
    join(@prefix, @rel)
  end
end

#pipe? ⇒ Boolean

Returns:

  • (Boolean) 


1288
1289
1290
1291
 
# File 'lib/fileutils.rb', line 1288

def pipe?
  s = lstat!
  s and s.pipe?
end

#platform_support ⇒ Object 



1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
 
# File 'lib/fileutils.rb', line 1458

def platform_support
  return yield unless fu_windows?
  first_time_p = true
  begin
    yield
  rescue Errno::ENOENT
    raise
  rescue => err
    if first_time_p
      first_time_p = false
      begin
        File.chmod 0700, path()   # Windows does not have symlink
        retry
      rescue SystemCallError
      end
    end
    raise err
  end
end

#postorder_traverse {|_self| ... } ⇒ Object

Yields:

  • (_self)

Yield Parameters:



1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
 
# File 'lib/fileutils.rb', line 1488

def postorder_traverse
  if directory?
    entries().each do |ent|
      ent.postorder_traverse do |e|
        yield e
      end
    end
  end
  yield self
end

#prefix ⇒ Object 



1242
1243
1244
 
# File 'lib/fileutils.rb', line 1242

def prefix
  @prefix || @path
end

#preorder_traverse ⇒ Object Also known as: traverse 



1478
1479
1480
1481
1482
1483
1484
 
# File 'lib/fileutils.rb', line 1478

def preorder_traverse
  stack = [self]
  while ent = stack.pop
    yield ent
    stack.concat ent.entries.reverse if ent.directory?
  end
end

#rel ⇒ Object 



1246
1247
1248
 
# File 'lib/fileutils.rb', line 1246

def rel
  @rel
end

#remove ⇒ Object 



1438
1439
1440
1441
1442
1443
1444
 
# File 'lib/fileutils.rb', line 1438

def remove
  if directory?
    remove_dir1
  else
    remove_file
  end
end

#remove_dir1 ⇒ Object 



1446
1447
1448
1449
1450
 
# File 'lib/fileutils.rb', line 1446

def remove_dir1
  platform_support {
    Dir.rmdir path().chomp(?/)
  }
end

#remove_file ⇒ Object 



1452
1453
1454
1455
1456
 
# File 'lib/fileutils.rb', line 1452

def remove_file
  platform_support {
    File.unlink path
  }
end

#socket? ⇒ Boolean

Returns:

  • (Boolean) 


1283
1284
1285
1286
 
# File 'lib/fileutils.rb', line 1283

def socket?
  s = lstat!
  s and s.socket?
end

#stat ⇒ Object 



1308
1309
1310
1311
1312
1313
1314
1315
1316
 
# File 'lib/fileutils.rb', line 1308

def stat
  return @stat if @stat
  if lstat() and lstat().symlink?
    @stat = File.stat(path())
  else
    @stat = lstat()
  end
  @stat
end

#stat! ⇒ Object 



1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
 
# File 'lib/fileutils.rb', line 1318

def stat!
  return @stat if @stat
  if lstat! and lstat!.symlink?
    @stat = File.stat(path())
  else
    @stat = lstat!
  end
  @stat
rescue SystemCallError
  nil
end

#symlink? ⇒ Boolean

Returns:

  • (Boolean) 


1268
1269
1270
1271
 
# File 'lib/fileutils.rb', line 1268

def symlink?
  s = lstat!
  s and s.symlink?
end

#wrap_traverse(pre, post) ⇒ Object 



1499
1500
1501
1502
1503
1504
1505
1506
1507
 
# File 'lib/fileutils.rb', line 1499

def wrap_traverse(pre, post)
  pre.call self
  if directory?
    entries.each do |ent|
      ent.wrap_traverse pre, post
    end
  end
  post.call self
end