Quiq::Path - Dateisystem-Operationen
Quiq::Object
Die Klasse definiert alle grundlegenden (link, mkdir, rename, symlink usw.) und komplexen (copy, glob, find usw.) Dateisystem-Operationen. Eine Dateisystem-Operation ist eine Operation auf einem Pfad.
$p = $class->new;
Path-Objekt
Instantiiere ein Objekt der Klasse und liefere eine Referenz auf dieses Objekt zurück. Da die Klasse ausschließlich Klassenmethoden enthält, hat das Objekt ausschließlich die Funktion, eine abkürzende Aufrufschreibweise zu ermöglichen.
$this->append($file,$data,@opt);
Pfad der Datei.
Daten, die auf die Datei geschrieben werden.
Locke die Datei während des Schreibens exklusiv.
Hänge Daten $data an Datei $file an.
$this->checkFileSecurity($file); # nur Owner darf schreiben und lesen $this->checkFileSecurity($file,$readableByOthers); # nur Owner darf schreiben
Datei, deren Rechte geprüft werden.
Wenn wahr, dürfen auch andere die Datei lesen.
Prüfe, ob die Datei $file vor unerlaubtem Zugriff geschützt ist. Wenn nicht, wirf eine Exception.
Per Default darf die Datei nur für ihren Owner lesbar und schreibbar sein, muss also die Zugriffsrechte rw------- besitzen.
Ist $readable wahr, darf die Datei von der Gruppe und anderen gelesen werden, darf also die Zugriffsrechte rw-r--r-- besitzen.
$bool = $class->compare($file1,$file2);
Prüfe, ob der Inhalt der Dateien $file1 und $file2 differiert. Ist dies der Fall, liefere wahr, andernfalls falsch.
$bool = $class->compareData($file,$data);
different()
Prüfe, ob der Inhalt der Datei $file von $data differiert. Ist dies der Fall, liefere wahr, andernfalls falsch. Die Datei $file muss nicht existieren.
$class->copy($srcPath,$destPath,@opt);
Erzeuge Zielverzeichnis, falls es nicht existiert.
Lösche Quelldatei $srcPath nach dem Kopieren.
Wenn gesetzt, wird die Zieldatei $destPath überschrieben, falls sie existiert. Andernfalls wird eine Exception geworfen.
Behalte den Zeitpunkt der letzten Änderung bei.
Kopiere Datei $srcPath nach $destPath.
$class->copyToDir($srcFile,$destDir,@opt);
$class->duplicate($method,$srcPath,$destPath,@opt);
Behalte den Zeitpunkt der letzten Änderung bei (nur bei 'copy' relevant).
Mache Datei $srcPath nach Methode $method unter $destPath verfügbar. Werte für $method:
copy move -or- rename link symlink
$changed = $this->edit($file);
Datei, die bearbeitet werden soll.
Boolschen Wert, der anzeigt, ob die Datei verändert wurde.
Öffne Datei $file im Editor, so dass diese vom Benutzer bearbeitet werden kann. Die Methode prüft nach Verlassen des Editors, ob die Datei geändert wurde. Falls ja, wird der Benutzer gefragt, ob er die Änderungen beibehalten möchte. Falls ja, liefert die Methode wahr, andernfalls falsch.
$encoding = $class->encoding($path,$altEncoding);
Analysiere Datei $path hinsichtlich ihres Character-Encodings und liefere den Encoding-Bezeichner zurück. Unterschieden werden:
ASCII
UTF-8
UTF-16/32 mit BOM
und $altEncoding. Ist $altEncoding nicht angegeben, wird 'ISO-8859-1' angenommen.
Anmerkung: Die Datei wird zur Zeichensatz-Analyse vollständig eingelesen. Bei großen Dateien kann dies ineffizient sein.
$class->link($path,$link);
Erzeuge einen Hardlink $link auf Pfad $path. Die Methode liefert keinen Wert zurück.
$nl = $class->newlineStr($file);
Ermittele den physischen Zeilentrenner (CR, LF oder CRLF) der Datei $file und liefere diesen zurück. Wird kein Zeilentrenner gefunden, liefere undef.
local $/ = Quiq::Path->newlineStr($file); while (<$fh>) { chomp; # Zeile verarbeiten }
$data = $class->read($file,@opt);
Auto-Dekodiere die gelesenen Daten als Text und entscheide selbständig, ob es sich um UTF-8 oder ISO-8859-1 Encoding handelt.
Decodiere die Datei gemäß dem Encoding $encoding.
Lösche Datei nach dem Lesen.
Lies höchstens $n Zeilen. Die Zählung beginnt nach den Skiplines (s. Option -skipLines). 0 bedeutet, lies alle Zeilen.
Überlies alle Zeilen, die das Muster $regex erfüllen. $regex wird als Zeichenkette angegeben. Die Option kann beispielsweise dazu verwendet werden, um Kommentarzeilen zu überlesen.
Überlies die ersten $n Zeilen.
Lies den Inhalt der Datei und liefere diesen zurück.
$this->truncate($file);
Kürze Datei $file auf Länge 0, falls sie existiert. Existiert die Datei nicht, geschieht nichts.
$class->write($file); # leere Datei $class->write($file,$data,@opt); $class->write($file,\$data,@opt);
Öffne die Datei im Append-Modus, d.h. hänge die Daten an die Datei an.
Encodiere $data gemäß dem Encoding $encoding.
Setze während des Schreibens einen Exclusive-Lock auf die Datei. Dies kann im Fallen von -append sinnvoll sein.
Setze die Permissions der Datei auf $mode. Beispiel: -mode=>0775
Erzeuge übergeordnete Verzeichnisse, wenn nötig.
Wende Quiq::Unindent->trimNl() auf die Daten $data an. Dies ist für inline geschriebenen Text nützlich.
$class->writeIfDifferent($file,$data);
$class->writeInline($file,<<'__EOT__',@opt); DATA ... __EOT__
$n = $this->count($dir);
Pfad des Verzeichnisses.
Anzahl Verzeichniseinträge (Integer)
Ermittele die Anzahl Einträge des Verzeichnisses $dir und liefere diese zurück. Die Einträge . und .. werden nicht mitgezählt.
.
..
@paths | $pathA = $this->entries($dir,@opt);
Dekodiere die Verzeichniseinträge gemäß Zeichensatz $charset.
Liste der Verzeichniseinträge (Array of Strings). Im Skalarkontext eine Referenz auf die Liste.
Ermittele die Einträge des Verzeichnisses $dir und liefere diese als Liste zurück. Die Liste umfasst alle Verzeichniseinträge außer . und ...
@paths|$pathA = $class->find($path,@opt);
Dekodiere die Dateinamen gemäß dem angegebenen Encoding.
Schließe alle Pfade aus, die Muster $regex erfüllen. Directories werden gepruned, d.h. sie werden nicht durchsucht. Matcht ein Pfad die Pattern sowohl von -pattern als auch -exclude, hat der exclude-Pattern Vorrang, d.h. die Datei wird ausgeschlossen.
Folge Symbolic Links.
Liefere nur Pfade, die kein Anfang eines anderen Pfads sind. Anwendungsfall: nur die Blatt-Verzeichnisse eines Verzeichnisbaums.
Liefere nur Dateien, die vor mindestens $seconds zuletzt geändert wurden. Diese Option ist z.B. nützlich, um veraltete temporäre Dateien zu finden, um sie zu löschen.
Filehandle, auf die Ausgabe im Falle von -verbose=>1 geschrieben werden.
Schränke die Treffer auf jene Pfade ein, die Muster $regex erfüllen. Matcht ein Pfad die Pattern sowohl von -pattern als auch -exclude, hat der exclude-Pattern Vorrang, d.h. die Datei wird ausgeschlossen.
Füge einen Slash (/) am Ende von Directory-Namen hinzu.
Wirf keine Exception, wenn $path nicht existiert, sondern liefere undef bzw. eine leere Liste.
Liefere nur den Subpfad, entferne also $path am Anfang.
Subroutine, die den Pfad als Argument erthält und einen boolschen Wert liefert, der angibt, ob der Pfad zur Ergebnismenge gehört oder nicht.
Liefere nur Verzeichnisse ('d') oder nur, was kein Verzeichnis ist ('f'), oder liefere alles (undef).
Schreibe Meldungen auf Ausgabe-Handle (s. Option -outHandle).
Finde alle Dateien und Verzeichnisse unterhalb von und einschließlich Verzeichnis $path und liefere die Liste der gefundenen Pfade zurück. Im Skalarkontext liefere eine Referenz auf die Liste.
Ist $dir Null (Leerstring oder undef), wird das aktuelle Verzeichnis ('.') durchsucht.
Die Reihenfolge der Dateien ist undefiniert.
$path = $class->findProgram($program); $path = $class->findProgram($program,$sloppy);
Name des Programms.
Wenn wahr, wird keine Exception geworfen, wenn das Programm nicht gefunden wird, sondern undef zurück geliefert.
Programmpfad (String)
Suche Programm $program über den Suchpfad der Shell und liefere den vollständigen Pfad zurück. Wird das Programm nicht gefunden, wird eine Exception geworfen, sofern $sloppy nicht wahr ist.
$max = $class->maxFilename($dir);
Liefere den lexikalisch größten Dateinamen aus Verzeichnis $dir.
$max = $class->maxFileNumber($dir,@opt);
Wirf keine Exception, wenn ein Dateiname nicht mit einer Nummer beginnt.
Liefere den numerisch größten Dateinamen aus Verzeichnis $dir. Die Methode ist nützlich, wenn die Dateinamen mit einer Zahl NNNNNN beginnen und man die Datei mit der größten Zahl ermitteln möchte um einer neu erzeugten Datei die nächsthöhere Nummer zuzuweisen.
$class->mkdir($dir,@opt);
Erzeuge nicht den angegebenen Pfad, sondern den Parent-Pfad. Dies ist nützlich, wenn der übergebene Pfad ein Dateiname ist, dessen Verzeichnis bei Nicht-Existenz erzeugt werden soll. Impliziert -recursive=>1, wenn nicht explizit -recursive=>0 gesetzt ist.
Setze Verzeichnisrechte auf $mode ohne Berücksichtigung der umask des Prozesses.
Setze Verzeichnisrechte auf $mode mit Berücksichtigung der umask des Prozesses.
Das Verzeichnis darf nicht existieren. Wenn es existiert, wird eine Exception geworfen.
Erzeuge Verzeichnis. Existiert das Verzeichnis bereits, hat der Aufruf keinen Effekt. Kann das Verzeichnis nicht angelegt werden, wird eine Exception ausgelöst.
$class->rmdir($dir);
Pfad des Verzeichnisses
nichts
Lösche Verzeichnis $dir, falls dieses leer ist. Kann das Verzeichnis nicht gelöscht werden, wird eine Exception ausgelöst.
$absolutePath = $class->absolute($path);
realPath()
Ist $path ein relativer Pfad, expandiere ihn zu einem absolutem Pfad und liefere diesen zurück. Ist $path bereits absolut, liefere ihn unverändert.
$basename = $class->basename($path,@opt);
baseName()
Entferne alle, nicht nur die erste Extension.
Liefere den Grundnamen des Pfads, d.h. ohne Pfadanfang und Extension.
$class->chmod($path,$mode);
Setze Zugriffsrechte $mode auf Pfad $path.
$class->delete($path);
Lösche den Pfad aus dem Dateisystem, also entweder die Datei oder das Verzeichnis einschließlich Inhalt. Es ist kein Fehler, wenn der Pfad im Dateisystem nicht existiert. Existiert der Pfad und kann nicht gelöscht werden, wird eine Exception ausgelöst. Die Methode liefert keinen Wert zurück.
$bool = $this->exists($path);
Prüfe, ob Pfad $path existiert und liefere den entsprechenden Wahrheitswert zurück. Die Methode expandiert ~ am Pfadanfang.
$path = $class->expandTilde($path);
Pfad (String)
Ersetze eine Tilde am Pfadanfang durch das Home-Verzeichnis des Benutzers und liefere den resultierenden Pfad zurück.
$ext = $class->extension($path);
Ermittele die Extension des Pfads $path und liefere diese zurück. Besitzt der Pfad keine Extension, liefere einen Leerstring ('').
$newPath = $this->newExtension($path,$ext);
Entferne die bestehende Extension von Pfad $path und füge $ext als neue Extension hinzu. Besitzt $path keine Extension, wird $ext hinzugefügt. Etension $ext kann mit oder ohne Punkt am Anfang angegeben werden.
$filename = $class->filename($path);
Liefere die letzte Komponente des Pfads.
$path = $this->glob($pat); @paths = $this->glob($pat);
Liefere die Pfad-Objekte, die Shell-Pattern $pat erfüllen. Im Skalarkontext liefere den ersten Pfad, der dann der einzig erfüllbare Pfad sein muss, sonst wird eine Exception geworfen.
$bool = $class->isEmpty($path);
$mode = $this->mode($path);
Liefere die Zugriffsrechte des Pfads $path.
Permissions oktal anzeigen
printf "%04o\n",Quiq::Path->mode('/etc/passwd'); 0644
Prüfen, ob eine Datei für andere lesbar oder schreibbar ist
if ($mode & 00066) { die "ERROR: File ist readable or writable for others\n"; }
$mtime = $class->mtime($path); $mtime = $class->mtime($path,$mtime);
Liefere die Zeit der letzten Modifikation des Pfads $path. Wenn der Pfad nicht existiert, liefere 0.
Ist ein zweiter Parameter $mtime angegeben, setze die Zeit auf den angegebenen Wert. In dem Fall muss der Pfad existieren.
$bool = $class->newer($path1,$path2);
Prüfe, ob Pfad $path1 ein jüngeres Modifikationsdatum besitzt als $path2. Ist dies der Fall, liefere 1, andernfalls 0. Liefere ebenfalls 1, wenn Datei $path2 nicht existiert. Pfad $path1 muss existieren.
Pfad $path2 kann eine Zeichenkette oder ein Pfad-Objekt sein.
Dieser Test ist nützlich, wenn $path2 aus $path1 erzeugt wird und geprüft werden soll, ob eine Neuerzeugung notwendig ist.
$path = $class->readlink($symlinkPath);
readLink()
Liefere den Pfad, auf den der Symlink $symlinkPath zeigt.
$newPath = $class->removeExtension($path);
Entferne die Extension von Pfad $path und liefere den resultierenden Pfad zurück. Besitzt $path keine Extension, sind $path und $newPath identisch.
$class->rename($oldPath,$newPath,@opt);
Wenn gesetzt, wird die Datei $newPath überschrieben, falls sie existiert. Wenn nicht gesetzt, wird eine Exception geworfen, falls sie existiert.
Erzeuge nicht-existente Verzeichnisse des Zielpfads und entferne leere Verzeichnisse des Quellpfads.
Benenne Pfad $oldPath in $newPath um. Die Methode liefert keinen Wert zurück.
Zielpfad erzeugen, Quellpfad entfernen mit -recursive=>1. Ausgangslage: Unterhalb von /tmp existieren weder a noch x.
my $srcPath = '/tmp/a/b/c/d/f'; my $destPath = '/tmp/x/b/c/d/f'; Quiq::Path->write($srcPath,'',-recursive=>1); Quiq::Path->rename($srcPath,$destPath,-recursive=>1);
Nach Ausführung existiert der der Pfad /tmp/x/b/c/d/f, aber der Pfad /tmp/a nicht mehr.
($dir,$file,$base,$ext) = $class->split($path);
Zerlege Pfad in die vier Komponenten Verzeichnisname, Dateiname, Basisname (= Dateiname ohne Extension) und Extension und liefere diese zurück.
Für eine Komponente, die nicht existiert, wird ein Leerstring geliefert.
$class->symlink($path,$symlink);
Erzeuge Symlink $symlink für Pfad $path. Die Methode liefert keinen Wert zurück.
$class->symlinkRelative($path,$symlink,@opt);
Erzeuge nicht-existente Verzeichnisse des Zielpfads.
Führe das Kommando nicht aus. Speziell Verbindung mit -verbose=>1 sinnvoll, um Code zu testen.
Gib Informationen über die erzeugten Symlinks auf STDOUT aus.
Erzeuge einen Symlink $symlink, der auf den Pfad $path verweist. Die Methode liefert keinen Wert zurück.
Die Methode zeichnet sich gegenüber der Methode symlink() dadurch aus, dass sie, wenn $path ein relativer Pfad ist, diesen so korrigiert, dass er von $symlink aus korrekt ist. Denn der Pfad $path múss als relativer Pfad als Fortsetzung von $symlink gesehen werden.
Quiq::Path->symlinkRelative('a','x') # x => a Quiq::Path->symlinkRelative('a/b','x') # x => a/b Quiq::Path->symlinkRelative('a/b','x/y') # x/y => ../a/b Quiq::Path->symlinkRelative('a/b','x/y/z') # x/y/z => ../../a/b
1.144
Frank Seitz, http://fseitz.de/
Copyright (C) 2019 Frank Seitz
This code is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
To install Quiq, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Quiq
CPAN shell
perl -MCPAN -e shell install Quiq
For more information on module installation, please visit the detailed CPAN module installation guide.