From: Jan Büren Date: Mon, 26 Nov 2018 11:22:09 +0000 (+0100) Subject: Weitere Fallback-Module entfernt und Doku angepasst (s.a. #344) X-Git-Tag: release-3.5.4~206 X-Git-Url: http://wagnertech.de/git?a=commitdiff_plain;h=ab18d1c0c613c094e576be22c0f788dfa19165bc;p=kivitendo-erp.git Weitere Fallback-Module entfernt und Doku angepasst (s.a. #344) --- diff --git a/SL/InstallationCheck.pm b/SL/InstallationCheck.pm index ed323ad86..9fdfb8fff 100644 --- a/SL/InstallationCheck.pm +++ b/SL/InstallationCheck.pm @@ -35,8 +35,9 @@ BEGIN { { name => "Email::MIME", url => "http://search.cpan.org/~rjbs/", debian => 'libemail-mime-perl' }, { name => "FCGI", version => '0.72', url => "http://search.cpan.org/~mstrout/", debian => 'libfcgi-perl' }, { name => "File::Copy::Recursive", url => "http://search.cpan.org/~dmuey/", debian => 'libfile-copy-recursive-perl' }, - { name => "File::Flock", version => '2008.01', url => "http://search.cpan.org/~muir/", }, # fallback version 98 + { name => "File::Flock", version => '2008.01', url => "http://search.cpan.org/~muir/", debian => 'libfile-flock-perl' }, { name => "File::MimeInfo", url => "http://search.cpan.org/~michielb/", debian => 'libfile-mimeinfo-perl' }, + { name => "File::Slurp", url => "https://metacpan.org/author/CAPOEIRAB", debian => 'libfile-slurp-perl' }, { name => "GD", url => "http://search.cpan.org/~lds/", debian => 'libgd-gd2-perl', }, { name => 'HTML::Parser', url => 'http://search.cpan.org/~gaas/', debian => 'libhtml-parser-perl', }, { name => 'HTML::Restrict', url => 'http://search.cpan.org/~oalders/', debian => 'libhtml-restrict-perl'}, @@ -54,7 +55,7 @@ BEGIN { { name => "Rose::DB", url => "http://search.cpan.org/~jsiracusa/", debian => 'librose-db-perl' }, { name => "Rose::DB::Object", version => 0.788, url => "http://search.cpan.org/~jsiracusa/", debian => 'librose-db-object-perl' }, { name => "Set::Infinite", version => '0.63', url => "http://search.cpan.org/~fglock/", debian => 'libset-infinite-perl' }, - { name => "Set::Crontab", version => '1.03', url => "http://search.cpan.org/~ams/", }, + { name => "Set::Crontab", version => '1.03', url => "http://search.cpan.org/~ams/", debian => 'libset-crontab-perl' }, { name => "String::ShellQuote", version => 1.01, url => "http://search.cpan.org/~rosch/", debian => 'libstring-shellquote-perl' }, { name => "Sort::Naturally", url => "http://search.cpan.org/~sburke/", debian => 'libsort-naturally-perl' }, # Test::Harness is core, so no Debian packages. Test::Harness 3.00 was first packaged in 5.10.1 diff --git a/doc/UPGRADE b/doc/UPGRADE index 92744a951..045e789f9 100644 --- a/doc/UPGRADE +++ b/doc/UPGRADE @@ -5,7 +5,7 @@ Wichtige Hinweise zum Upgrade von älteren Versionen ** BITTE FERTIGEN SIE VOR DEM UPGRADE EIN BACKUP IHRER DATENBANK(EN) AN! ** -Upgrade auf v3.x.x +Upgrade auf v3.5.3 * Fallback-Module entfernt @@ -13,6 +13,7 @@ Einige Default-Module die als Fallback zu Verfügung standen, werden ab dieser Version nicht mehr mit ausgeliefert. Bitte vor dem Anmelden an der Weboberfläche 'scripts/installation_check.pl -v' ausführen und die entsprechenden Module installieren. +S.a. weitere Details in der aktuellen kivitendo-Dokumentation. Upgrade auf v3.5.1 diff --git a/doc/dokumentation.xml b/doc/dokumentation.xml index 5066f87e9..cf15b4e5b 100644 --- a/doc/dokumentation.xml +++ b/doc/dokumentation.xml @@ -338,7 +338,15 @@ Set::Infinite, List::UtilsBy, DateTime::Set, - DateTime::Event::Cron + DateTime::Event::Cron + Daemon::Generic + DateTime::Event::Cron + File::Flock + File::Slurp + Set::Crontab + Exception::Lite +Für die letzten beiden Module liefert kivitendo fallback-Module aus, da +diese überhaupt nicht in debian oder in der benötigten Version zu Verfügung stehen (Stand Anfang 2019). Seit Version größer v3.5.0 sind die folgenden Pakete hinzugekommen: Text::Unidecode, @@ -400,7 +408,9 @@ libfile-copy-recursive-perl postgresql libalgorithm-checkdigits-perl \ libcrypt-pbkdf2-perl git libcgi-pm-perl libtext-unidecode-perl libwww-perl\ postgresql-contrib aqbanking-tools poppler-utils libhtml-restrict-perl\ - libdatetime-event-cron-perl libdatetime-set-perl libset-infinite-perl liblist-utilsby-perl + libdatetime-set-perl libset-infinite-perl liblist-utilsby-perl\ + libdaemon-generic-perl libfile-flock-perl libfile-slurp-perl + Ab Ubuntu Version 18.04 LTS sind alle benötigten Pakete in der Distributions verfügbar. Für ältere Ubuntu/Debians müßen einige Pakete per CPAN installiert werden. diff --git a/doc/html/ch02s02.html b/doc/html/ch02s02.html index 4581795af..090b72e52 100644 --- a/doc/html/ch02s02.html +++ b/doc/html/ch02s02.html @@ -97,7 +97,23 @@ List::UtilsBy, DateTime::Set, DateTime::Event::Cron -

Seit Version größer v3.5.0 sind die folgenden Pakete + + Daemon::Generic + + DateTime::Event::Cron + + File::Flock + + File::Slurp + + Set::Crontab + + Exception::Lite + +

Für die letzten beiden Module liefert kivitendo fallback-Module aus, da +diese überhaupt nicht in debian oder in der benötigten Version zu Verfügung stehen (Stand Anfang 2019). + +

Seit Version größer v3.5.0 sind die folgenden Pakete hinzugekommen: Text::Unidecode, LWP::Authen::Digest, LWP::UserAgent @@ -124,7 +140,7 @@ sind auch in 2.6.1 weiterhin mit ausgeliefert, wurden in einer zukünftigen Version aber aus dem Paket entfernt werden. Es wird empfohlen diese Module zusammen mit den anderen als Bibliotheken zu - installieren.

2.2.2.1. Debian und Ubuntu

Für Debian und Ubuntu stehen die meisten der benötigten + installieren.

2.2.2.1. Debian und Ubuntu

Für Debian und Ubuntu stehen die meisten der benötigten Pakete als Debian-Pakete zur Verfügung. Sie können mit folgendem Befehl installiert werden:

apt install  apache2 libarchive-zip-perl libclone-perl \
   libconfig-std-perl libdatetime-perl libdbd-pg-perl libdbi-perl \
@@ -138,10 +154,12 @@
   libfile-copy-recursive-perl postgresql libalgorithm-checkdigits-perl \
   libcrypt-pbkdf2-perl git libcgi-pm-perl libtext-unidecode-perl libwww-perl\
   postgresql-contrib aqbanking-tools poppler-utils libhtml-restrict-perl\
-  libdatetime-event-cron-perl libdatetime-set-perl libset-infinite-perl liblist-utilsby-perl
+  libdatetime-set-perl libset-infinite-perl liblist-utilsby-perl\
+  libdaemon-generic-perl libfile-flock-perl libfile-slurp-perl
+

Ab Ubuntu Version 18.04 LTS sind alle benötigten Pakete in der Distributions verfügbar.

Für ältere Ubuntu/Debians müßen einige Pakete per CPAN installiert werden. Das geht bspw. für das benötige Paket HTML::Restrict mit:

apt-get install build-essential
-cpan HTML::Restrict

2.2.2.2. Fedora

Für Fedora stehen die meisten der benötigten Perl-Pakete als +cpan HTML::Restrict

2.2.2.2. Fedora

Für Fedora stehen die meisten der benötigten Perl-Pakete als RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl installiert werden:

dnf install httpd mod_fcgid perl-Archive-Zip perl-Clone perl-DBD-Pg \
   perl-DBI perl-DateTime perl-Email-Address perl-Email-MIME perl-FCGI \
@@ -151,7 +169,7 @@ cpan HTML::Restrict

Zusätzlich müssen einige Pakete aus dem CPAN installiert - werden. Dazu können Sie die folgenden Befehle nutzen:

cpan Config::Std HTML::Restrict

2.2.2.3. openSUSE

Für openSUSE stehen die meisten der benötigten Perl-Pakete als + werden. Dazu können Sie die folgenden Befehle nutzen:

cpan Config::Std HTML::Restrict

2.2.2.3. openSUSE

Für openSUSE stehen die meisten der benötigten Perl-Pakete als RPM-Pakete zur Verfügung. Sie können mit folgendem Befehl installiert werden:

zypper install apache2 apache2-mod_fcgid perl-Archive-Zip perl-Clone \
   perl-Config-Std perl-DBD-Pg perl-DBI perl-DateTime perl-Email-Address \
@@ -160,7 +178,7 @@ cpan HTML::Restrict

Zusätzlich müssen einige Pakete aus dem CPAN installiert - werden. Dazu können Sie die folgenden Befehle nutzen:

cpan Rose::Db::Object

2.2.3. Andere Pakete installieren

Seit Version v3.4.0 wird für den Bankimport optional das Paket + werden. Dazu können Sie die folgenden Befehle nutzen:

cpan Rose::Db::Object

2.2.3. Andere Pakete installieren

Seit Version v3.4.0 wird für den Bankimport optional das Paket 'aqbanking-tools' benötigt.

Debian und Ubuntu: 

apt install aqbanking-tools

Fedora: 

dnf install aqbanking

diff --git a/doc/html/ch02s06.html b/doc/html/ch02s06.html index 059011081..f652a7c9d 100644 --- a/doc/html/ch02s06.html +++ b/doc/html/ch02s06.html @@ -1,6 +1,6 @@ - 2.6. Webserver-Konfiguration

2.6. Webserver-Konfiguration
Zurück Kapitel 2. Installation und Grundkonfiguration Weiter

2.6. Webserver-Konfiguration

2.6.1. Grundkonfiguration mittels CGI

[Anmerkung]Anmerkung

Für einen deutlichen Performanceschub sorgt die Ausführung + 2.6. Webserver-Konfiguration

2.6. Webserver-Konfiguration
Zurück Kapitel 2. Installation und Grundkonfiguration Weiter

2.6. Webserver-Konfiguration

2.6.1. Grundkonfiguration mittels CGI

[Anmerkung]Anmerkung

Für einen deutlichen Performanceschub sorgt die Ausführung mittels FastCGI/FCGI. Die Einrichtung wird ausführlich im Abschnitt Konfiguration für FastCGI/FCGI beschrieben.

Der Zugriff auf das Programmverzeichnis muss in der Apache Webserverkonfigurationsdatei httpd.conf eingestellt @@ -106,7 +106,7 @@ AliasMatch ^/url/for/kivitendo-erp-fcgid/[^/]+\.pl /path/to/kivitendo-erp/dispat Alias /url/for/kivitendo-erp-fcgid/ /path/to/kivitendo-erp/

Dann ist unter /url/for/kivitendo-erp/ die normale Version erreichbar, und unter /url/for/kivitendo-erp-fcgid/ die - FastCGI-Version.

2.6.3. Weitergehende Konfiguration

Für einen deutlichen Sicherheitsmehrwert sorgt die Ausführung + FastCGI-Version.

2.6.3. Weitergehende Konfiguration

Für einen deutlichen Sicherheitsmehrwert sorgt die Ausführung von kivitendo nur über https-verschlüsselten Verbindungen, sowie weiteren Zusatzmassnahmen, wie beispielsweise Basic Authenticate. Die Konfigurationsmöglichkeiten sprengen allerdings den Rahmen dieser diff --git a/doc/html/ch02s07.html b/doc/html/ch02s07.html index b5ca0bfff..4b9545193 100644 --- a/doc/html/ch02s07.html +++ b/doc/html/ch02s07.html @@ -39,7 +39,7 @@ Links aus einem der Runlevel-Verzeichnisse heraus in den Boot-Prozess einzubinden. Da das bei neueren Linux-Distributionen aber nicht zwangsläufig funktioniert, werden auch Start-Scripte mitgeliefert, die - anstelle eines symbolischen Links verwendet werden können.

2.7.3.1. SystemV-basierende Systeme (z.B. ältere Debian, ältere + anstelle eines symbolischen Links verwendet werden können.

2.7.3.1. SystemV-basierende Systeme (z.B. ältere Debian, ältere openSUSE, ältere Fedora)

Kopieren Sie die Datei scripts/boot/system-v/kivitendo-task-server nach /etc/init.d/kivitendo-task-server. Passen @@ -47,12 +47,12 @@ DAEMON=....). Binden Sie das Script in den Boot-Prozess ein. Dies ist distributionsabhängig:

  • Debian-basierende Systeme:

    update-rc.d kivitendo-task-server defaults
 insserv kivitendo-task-server

  • Ältere openSUSE und ältere Fedora:

    chkconfig --add kivitendo-task-server

Danach kann der Task-Server mit dem folgenden Befehl gestartet - werden:

/etc/init.d/kivitendo-task-server start

2.7.3.2. Upstart-basierende Systeme (z.B. Ubuntu bis 14.04)

Kopieren Sie die Datei + werden:

/etc/init.d/kivitendo-task-server start

2.7.3.2. Upstart-basierende Systeme (z.B. Ubuntu bis 14.04)

Kopieren Sie die Datei scripts/boot/upstart/kivitendo-task-server.conf nach /etc/init/kivitendo-task-server.conf. Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile exec ....).

Danach kann der Task-Server mit dem folgenden Befehl gestartet - werden:

service kivitendo-task-server start

2.7.3.3. systemd-basierende Systeme (z.B. neure openSUSE, neuere + werden:

service kivitendo-task-server start

2.7.3.3. systemd-basierende Systeme (z.B. neure openSUSE, neuere Fedora, neuere Ubuntu und neuere Debians)

Kopieren Sie die Datei scripts/boot/systemd/kivitendo-task-server.service nach /etc/systemd/system/. Passen Sie in der diff --git a/doc/html/ch02s13.html b/doc/html/ch02s13.html index ab29d0baa..d88db3f04 100644 --- a/doc/html/ch02s13.html +++ b/doc/html/ch02s13.html @@ -63,14 +63,14 @@ Verzeichnis umbenannt werden.

Dieses Verzeichnis, wie auch das komplette users-Verzeichnis, muss vom Webserver beschreibbar sein. Dieses wurde bereits erledigt (siehe Manuelle Installation des Programmpaketes), kann aber erneut - überprüft werden, wenn die Konvertierung nach PDF fehlschlägt.

2.13.1. OpenDocument (odt) Druckvorlagen mit Makros

OpenDocument Vorlagen können Makros enthalten, welche komplexere + überprüft werden, wenn die Konvertierung nach PDF fehlschlägt.

2.13.1. OpenDocument (odt) Druckvorlagen mit Makros

OpenDocument Vorlagen können Makros enthalten, welche komplexere Aufgaben erfüllen.

Der Vorlagensatz "rev-odt" enthält solche Vorlagen mit Schweizer Bank-Einzahlungsscheinen (BESR). Diese Makros haben die Aufgabe, die in den Einzahlungsscheinen benötigte Referenznummer und Kodierzeile zu erzeugen. Hier eine kurze Beschreibung, wie die Makros aufgebaut sind, und was bei ihrer Nutzung zu beachten ist (in fett sind nötige einmalige - Anpassungen aufgeführt):

2.13.1.1. Bezeichnung der Vorlagen

Rechnung: invoice_besr.odt, Auftrag: - sales_order_besr.odt

2.13.1.2. Vorbereitungen im Adminbereich

Damit beim Erstellen von Rechnungen und Aufträgen neben der + Anpassungen aufgeführt):

2.13.1.1. Bezeichnung der Vorlagen

Rechnung: invoice_besr.odt, Auftrag: + sales_order_besr.odt

2.13.1.2. Vorbereitungen im Adminbereich

Damit beim Erstellen von Rechnungen und Aufträgen neben der Standardvorlage ohne Einzahlungsschein weitere Vorlagen (z.B. mit Einzahlungsschein) auswählbar sind, muss für jedes Vorlagen-Suffix ein Drucker eingerichtet werden:

  • Druckeradministration → Drucker hinzufügen

  • Mandant wählen

  • Druckerbeschreibung → aussagekräftiger Text: wird in der @@ -79,11 +79,11 @@ Aufträgen oder Rechnungen als odt-Datei keine Bedeutung, darf aber nicht leer sein)

  • Vorlagenkürzel → besr bzw. selbst gewähltes Vorlagensuffix (muss genau der Zeichenfolge entsprechen, die zwischen - "invoice_" bzw. "sales_order_" und ".odt" steht.)

  • speichern

2.13.1.3. Benutzereinstellungen

Wer den Ausdruck mit Einzahlungsschein als Standardeinstellung + "invoice_" bzw. "sales_order_" und ".odt" steht.)

  • speichern

    • 2.13.1.3. Benutzereinstellungen

    Wer den Ausdruck mit Einzahlungsschein als Standardeinstellung im Rechnungs- bzw. Auftragsformular angezeigt haben möchte, kann dies persönlich für sich bei den Benutzereinstellungen konfigurieren:

    • Programm → Benutzereinstellungen → Druckoptionen

    • Standardvorlagenformat → OpenDocument/OASIS

    • Standardausgabekanal → Bildschirm

    • Standarddrucker → gewünschte Druckerbeschreibung auswählen - (z.B. mit Einzahlungsschein Bank xy)

    • Anzahl Kopien → leer

    • speichern

    2.13.1.4. Aufbau und nötige Anpassungen der Vorlagen

    In der Vorlage sind als Modul "BESR" 4 Makros gespeichert, die + (z.B. mit Einzahlungsschein Bank xy)

  • Anzahl Kopien → leer

  • speichern

    • 2.13.1.4. Aufbau und nötige Anpassungen der Vorlagen

    In der Vorlage sind als Modul "BESR" 4 Makros gespeichert, die aus dem von kivitendo erzeugten odt-Dokument die korrekte Referenznummer inklusive Prüfziffer sowie die Kodierzeile in OCRB-Schrift erzeugen und am richtigen Ort ins Dokument @@ -112,12 +112,12 @@ angepasst werden. Dabei ist darauf zu achten, dass sich die Positionen der Postkonto-Nummern der Bank, sowie der Zeichenfolgen dddfr, DDDREF1, DDDREF2, 609, DDDKODIERZEILE nicht - verschieben.

    2.13.1.5. Auswahl der Druckvorlage in kivitendo beim Erzeugen einer + verschieben.

    2.13.1.5. Auswahl der Druckvorlage in kivitendo beim Erzeugen einer odt-Rechnung (analog bei Auftrag)

    Im Fussbereich der Rechnungsmaske muss neben Rechnung, OpenDocument/OASIS und Bildschirm die im Adminbereich erstellte Druckerbeschreibung ausgewählt werden, falls diese nicht bereits bei den Benutzereinstellungen als persönlicher Standard gewählt - wurde.

    2.13.1.6. Makroeinstellungen in LibreOffice anpassen

    Falls beim Öffnen einer von kivitendo erzeugten odt-Rechnung + wurde.

    2.13.1.6. Makroeinstellungen in LibreOffice anpassen

    Falls beim Öffnen einer von kivitendo erzeugten odt-Rechnung die Meldung kommt, dass Makros aus Sicherheitsgründen nicht ausgeführt werden, so müssen folgende Einstellungen in LibreOffice angepasst werden:

    • Extras → Optionen → Sicherheit → Makrosicherheit

    • Sicherheitslevel auf "Mittel" einstellen (Diese diff --git a/doc/html/ch03s03.html b/doc/html/ch03s03.html index a06c736e9..d06cca854 100644 --- a/doc/html/ch03s03.html +++ b/doc/html/ch03s03.html @@ -613,7 +613,7 @@ invdate

      Rechnungsdatum

      invnumber -

      Rechnungsnummer

    3.3.10. Variablen in anderen Vorlagen

    3.3.10.1. Einführung

    Die Variablen in anderen Vorlagen sind ähnlich wie in der +

    Rechnungsnummer

    3.3.10. Variablen in anderen Vorlagen

    3.3.10.1. Einführung

    Die Variablen in anderen Vorlagen sind ähnlich wie in der Rechnung. Allerdings heißen die Variablen, die mit inv beginnen, jetzt anders. Bei den Angeboten fangen sie mit quo für "quotation" an: diff --git a/doc/html/ch03s07.html b/doc/html/ch03s07.html index b7fab52fe..6c98f8fa1 100644 --- a/doc/html/ch03s07.html +++ b/doc/html/ch03s07.html @@ -1,15 +1,15 @@ - 3.7. Artikelklassifizierung

    3.7. Artikelklassifizierung
    Zurück Kapitel 3. Features und Funktionen Weiter

    3.7. Artikelklassifizierung

    3.7.1. Übersicht

    Die Klassifizierung von Artikeln dient einer weiteren + 3.7. Artikelklassifizierung

    3.7. Artikelklassifizierung
    Zurück Kapitel 3. Features und Funktionen Weiter

    3.7. Artikelklassifizierung

    3.7.1. Übersicht

    Die Klassifizierung von Artikeln dient einer weiteren Gliederung, um zum Beispiel den Einkauf vom Verkauf zu trennen, gekennzeichnet durch eine Beschreibung (z.B. "Einkauf") und ein Kürzel (z.B. "E"). Für jede Klassifizierung besteht eine Beschreibung und eine Abkürzung die normalerweise aus einem Zeichen besteht, kann aber auf mehrere Zeichen erweitert werden, falls zur Unterscheidung - notwendig. Sinnvoll sind jedoch nur maximal 2 Zeichen.

    3.7.2. Basisklassifizierung

    Als Basisklassifizierungen gibt es

    • Einkauf

    • Verkauf

    • Handelsware

    • Produktion

    • - keine - (diese wird bei einer Aktualisierung für alle + notwendig. Sinnvoll sind jedoch nur maximal 2 Zeichen.

    3.7.2. Basisklassifizierung

    Als Basisklassifizierungen gibt es

    • Einkauf

    • Verkauf

    • Handelsware

    • Produktion

    • - keine - (diese wird bei einer Aktualisierung für alle existierenden Artikel verwendet und ist gültig für Verkauf und Einkauf)

    Es können weitere Klassifizierungen angelegt werden. So kann es - z.B. für separat auszuweisende Artikel folgende Klassen geben:

    • Lieferung (Logistik, Transport) mit Kürzel L

    • Material (Verpackungsmaterial) mit Kürzel M

    3.7.3. Attribute

    Bisher haben die Klassifizierungen folgende Attribute, die auch + z.B. für separat auszuweisende Artikel folgende Klassen geben:

    • Lieferung (Logistik, Transport) mit Kürzel L

    • Material (Verpackungsmaterial) mit Kürzel M

    3.7.3. Attribute

    Bisher haben die Klassifizierungen folgende Attribute, die auch alle gleichzeitg gültig sein können

    • gültig für Verkauf - dieser Artikel kann im Verkauf genutzt werden

    • gültig für Einkauf - dieser Artikel kann im Einkauf genutzt werden

    • separat ausweisen - hierzu gibt es zur Dokumentengenerierung @@ -19,7 +19,7 @@ pro separat auszuweisenden Klassifizierungen die Variable< %separate_X_subtotal%>, wobei X das Kürzel der Klassifizierung ist.

      Im obigen Beispiel wäre das für Lieferkosten <%separate_L_subtotal%> und für Verpackungsmaterial - <%separate_M_subtotal%>.

    3.7.4. Zwei-Zeichen Abkürzung

    Der Typ des Artikels und die Klassifizierung werden durch zwei + <%separate_M_subtotal%>.

    3.7.4. Zwei-Zeichen Abkürzung

    Der Typ des Artikels und die Klassifizierung werden durch zwei Buchstaben dargestellt. Der erste Buchstabe ist eine Lokalisierung des Artikel-Typs ('P','A','S'), deutsch 'W', 'E', und 'D' für Ware Erzeugnis oder Dienstleistung und ggf. weiterer Typen.

    Der zweite Buchstabe (und ggf. auch ein dritter, falls nötig) diff --git a/doc/html/ch03s08.html b/doc/html/ch03s08.html index a545b174d..5dc3a6701 100644 --- a/doc/html/ch03s08.html +++ b/doc/html/ch03s08.html @@ -1,10 +1,10 @@ - 3.8. Dateiverwaltung (Mini-DMS)

    3.8. Dateiverwaltung (Mini-DMS)
    Zurück Kapitel 3. Features und Funktionen Weiter

    3.8. Dateiverwaltung (Mini-DMS)

    3.8.1. Übersicht

    Parallel zum alten WebDAV gibt es ein Datei-Management-System, + 3.8. Dateiverwaltung (Mini-DMS)

    3.8. Dateiverwaltung (Mini-DMS)
    Zurück Kapitel 3. Features und Funktionen Weiter

    3.8. Dateiverwaltung (Mini-DMS)

    3.8.1. Übersicht

    Parallel zum alten WebDAV gibt es ein Datei-Management-System, das Dateien verschiedenen Typs verwaltet. Dies können

    1. aus ERP-Daten per LaTeX Template erzeugte PDF-Dokumente,

    2. zu bestimmten ERP-Daten gehörende Anhangdateien unterschiedlichen Formats,

    3. per Scanner eingelesene PDF-Dateien,

    4. per E-Mail empfangene Dateianhänge unterschiedlichen - Formats,

    5. sowie speziel für Artikel hochgeladene Bilder sein.

    3.8.2. Struktur

    Über eine vom Speichermedium unabhängige Zwischenschicht werden + Formats,

  • sowie speziel für Artikel hochgeladene Bilder sein.

    • 3.8.2. Struktur

    Über eine vom Speichermedium unabhängige Zwischenschicht werden die Dateien und ihre Versionen in der Datenbank verwaltet. Darunter können verschiedene Implementierungen (Backends) gleichzeitig existieren:

    • Dateisystem

    • WebDAV

    • Schnittstelle zu externen @@ -23,7 +23,7 @@ für "attachment" und "image" nur die Quelle "uploaded". Für "document" gibt es auf jeden Fall die Quelle "created". Die Quellen "scanner" und "email" müssen derzeit in der Datenbank konfiguriert werden (siehe - Datenbank-Konfigurierung).

    3.8.3. Anwendung

    Die Daten werden bei den ERP-Objekten als extra Reiter + Datenbank-Konfigurierung).

    3.8.3. Anwendung

    Die Daten werden bei den ERP-Objekten als extra Reiter dargestellt. Eine Verkaufsrechnung z.B. hat die Reiter "Dokumente" und "Dateianhänge".

    Bei den Dateianhängen wird immer nur die aktuelle Version einer Datei angezeigt. Wird eine Datei mit gleichem Namen hochgeladen, so @@ -39,13 +39,13 @@ so sind diese z.B. bei Einkaufsrechnungen sichtbar:

    Statt des Löschens wird hier die Datei zurück zur Quelle verschoben. Somit kann die Datei anschließend an ein anderes ERP-Objekt angehängt werden.

    Derzeit sind "Titel" und "Beschreibung" noch nicht genutzt. Sie - sind bisher nur bei Bildern relevant.

    3.8.4. Konfigurierung

    3.8.4.1. Mandantenkonfiguration

    3.8.4.1.1. Reiter "Features"

    Unter dem Reiter Features + sind bisher nur bei Bildern relevant.

    3.8.4. Konfigurierung

    3.8.4.1. Mandantenkonfiguration

    3.8.4.1.1. Reiter "Features"

    Unter dem Reiter Features im Abschnitt Dateimanagement ist neben dem "alten" WebDAV das Dateimangement generell zu- und abschaltbar, sowie die Zuordnung der Dateitypen zu Backends. Die Löschbarkeit von Dateien, sowie die maximale Uploadgröße sind Backend-unabhängig

    Die einzelnen Backends sind einzeln einschaltbar. Spezifische Backend-Konfigurierungen sind hier noch - ergänzbar.

    3.8.4.1.2. Reiter "Allgemeine Dokumentenanhänge"

    Unter dem Reiter Allgemeine + ergänzbar.

    3.8.4.1.2. Reiter "Allgemeine Dokumentenanhänge"

    Unter dem Reiter Allgemeine Dokumentenanhänge kann für alle ERP-Dokumente ( Angebote, Aufträge, Lieferscheine, Rechnungen im Verkauf und Einkauf ) allgemeingültige Anhänge hochgeladen werden.

    Diese Anhänge werden beim Generieren von PDF-Dateien an die diff --git a/doc/html/ch03s09.html b/doc/html/ch03s09.html index 476f64c2e..59cd527d1 100644 --- a/doc/html/ch03s09.html +++ b/doc/html/ch03s09.html @@ -1,13 +1,13 @@ - 3.9. Webshop-Api

    3.9. Webshop-Api
    Zurück Kapitel 3. Features und Funktionen Weiter

    3.9. Webshop-Api

    Das Shopmodul bietet die Möglichkeit Onlineshopartikel und + 3.9. Webshop-Api

    3.9. Webshop-Api
    Zurück Kapitel 3. Features und Funktionen Weiter

    3.9. Webshop-Api

    Das Shopmodul bietet die Möglichkeit Onlineshopartikel und Onlineshopbestellungen zu verwalten und zu bearbeiten.

    Es ist Multishopfähig, d.h. Artikel können mehreren oder unterschiedlichen Shops zugeordnet werden. Bestellungen können aus mehreren Shops geholt werden.

    Zur Zeit bietet das Modul nur einen Connector zur REST-Api von Shopware. Weitere Connectoren können dazu programmiert und eingerichtet - werden.

    3.9.1. Rechte für die Webshopapi

    In der Administration können folgende Rechte vergeben - werden

    • Webshopartikel anlegen und bearbeiten

    • Shopbestellungen holen und bearbeiten

    • Shop anlegen und bearbeiten

    3.9.2. Konfiguration

    Unter System->Webshops können Shops angelegt und konfiguriert - werden

    3.9.3. Webshopartikel

    3.9.3.1. Shopvariablenreiter in Artikelstammdaten

    Mit dem Recht "Shopartikel anlegen und bearbeiten" und des + werden.

    3.9.1. Rechte für die Webshopapi

    In der Administration können folgende Rechte vergeben + werden

    • Webshopartikel anlegen und bearbeiten

    • Shopbestellungen holen und bearbeiten

    • Shop anlegen und bearbeiten

    3.9.2. Konfiguration

    Unter System->Webshops können Shops angelegt und konfiguriert + werden

    3.9.3. Webshopartikel

    3.9.3.1. Shopvariablenreiter in Artikelstammdaten

    Mit dem Recht "Shopartikel anlegen und bearbeiten" und des Markers "Shopartikel" in den Basisdaten zeigt sich der Reiter "Shopvariablen" in den Artikelstammdaten. Hier können jetzt die Artikel mit @@ -16,11 +16,11 @@ Stelle können auch beliebig viele Bilder dem Shopartikel zugeordnet werden. Artikelbilder gelten für alle Shops.

    Die Artikelgruppen werden direkt vom Shopsystem geholt somit ist es möglich einen Artikel auch mehreren Gruppen - zuzuordenen

    3.9.3.2. Shopartikelliste

    Unter dem Menu Webshop->Webshop Artikel hat man nochmal + zuzuordenen

    3.9.3.2. Shopartikelliste

    Unter dem Menu Webshop->Webshop Artikel hat man nochmal eine Gesamtübersicht. Von hier aus ist es möglich Artikel im Stapel unter verschiedenen Kriterien <alles><nur Preis><nur Bestand><Preis und Bestand> an die jeweiligen Shops - hochzuladen.

    3.9.4. Bestellimport

    Unter dem Menupunkt Webshop->Webshop Import öffnet sich die + hochzuladen.

    3.9.4. Bestellimport

    Unter dem Menupunkt Webshop->Webshop Import öffnet sich die Bestellimportsliste. Hier ist sind Möglichkeiten gegeben Neue Bestellungen vom Shop abzuholen, geholte Bestellungen im Stapel oder einzeln als Auftrag zu transferieren. Die Liste kann nach @@ -52,7 +52,7 @@ auch der Grund für die Auftragssperre sein.

  • Die Buttons "Auftrag erstellen" und "Kunde mit Rechnungsadresse überschreiben" zeigen sich erst, wenn ein Kunde aus dem Listing ausgewählt ist.

  • Es ist aber möglich die Shopbestellung zu löschen.

  • Ist eine Bestellung schon übernommen, zeigen sich an dieser - Stelle, die dazugehörigen Belegverknüpfungen.

    • 3.9.5. Mapping der Daten

    Das Mapping der kivitendo Daten mit den Shopdaten geschieht in + Stelle, die dazugehörigen Belegverknüpfungen.

    3.9.5. Mapping der Daten

    Das Mapping der kivitendo Daten mit den Shopdaten geschieht in der Datei SL/ShopConnector/<SHOPCONNECTORNAME>.pm z.B.:SL/ShopConnector/Shopware.pm

    In dieser Datei gibt es einen Bereich wo die Bestellpostionen, die Bestellkopfdaten und die Artikeldaten gemapt werden. In dieser diff --git a/doc/html/ch04.html b/doc/html/ch04.html index ff99a5986..dfc9e5ccd 100644 --- a/doc/html/ch04.html +++ b/doc/html/ch04.html @@ -1,6 +1,6 @@ - Kapitel 4. Entwicklerdokumentation

    Kapitel 4. Entwicklerdokumentation
    Zurück   Weiter

    Kapitel 4. Entwicklerdokumentation

    4.1. Globale Variablen

    4.1.1. Wie sehen globale Variablen in Perl aus?

    Globale Variablen liegen in einem speziellen namespace namens + Kapitel 4. Entwicklerdokumentation

    Kapitel 4. Entwicklerdokumentation
    Zurück   Weiter

    Kapitel 4. Entwicklerdokumentation

    4.1. Globale Variablen

    4.1.1. Wie sehen globale Variablen in Perl aus?

    Globale Variablen liegen in einem speziellen namespace namens "main", der von überall erreichbar ist. Darüber hinaus sind bareword globs global und die meisten speziellen Variablen sind... speziell.

    Daraus ergeben sich folgende Formen:

    @@ -25,7 +25,7 @@ $PACKAGE::form.

    local $form

    Alle Änderungen an $form werden am Ende - des scopes zurückgesetzt

    4.1.2. Warum sind globale Variablen ein Problem?

    Das erste Problem ist FCGI™.

    + des scopes zurückgesetzt

    4.1.2. Warum sind globale Variablen ein Problem?

    Das erste Problem ist FCGI™.

    SQL-Ledger™ hat fast alles im globalen namespace abgelegt, und erwartet, dass es da auch wiederzufinden ist. Unter FCGI™ müssen diese Sachen aber wieder @@ -39,7 +39,7 @@ dies hat, seit der Einführung, u.a. schon so manche langwierige Bug-Suche verkürzt. Da globale Variablen aber implizit mit Package angegeben werden, werden die nicht geprüft, und somit kann sich - schnell ein Tippfehler einschleichen.

    4.1.3. Kanonische globale Variablen

    Um dieses Problem im Griff zu halten gibt es einige wenige + schnell ein Tippfehler einschleichen.

    4.1.3. Kanonische globale Variablen

    Um dieses Problem im Griff zu halten gibt es einige wenige globale Variablen, die kanonisch sind, d.h. sie haben bestimmte vorgegebenen Eigenschaften, und alles andere sollte anderweitig umhergereicht werden.

    Diese Variablen sind im Moment die folgenden neun:

    • @@ -62,7 +62,7 @@ $::request

    Damit diese nicht erneut als Müllhalde missbraucht werden, im Folgenden eine kurze Erläuterung der bestimmten vorgegebenen - Eigenschaften (Konventionen):

    4.1.3.1. $::form

    • Ist ein Objekt der Klasse + Eigenschaften (Konventionen):

      4.1.3.1. $::form

      • Ist ein Objekt der Klasse "Form"

      • Wird nach jedem Request gelöscht

      • Muss auch in Tests und Konsolenscripts vorhanden sein.

      • Enthält am Anfang eines Requests die Requestparameter vom User

      • Kann zwar intern über Requestgrenzen ein Datenbankhandle @@ -110,7 +110,7 @@ push @{ $form->{TEMPLATE_ARRAYS}{number} }, $form->{"partnumber_$i"}; push @{ $form->{TEMPLATE_ARRAYS}{description} }, $form->{"description_$i"}; # ... -}

      4.1.3.2. %::myconfig

      • Das einzige Hash unter den globalen Variablen

      • Wird spätestens benötigt wenn auf die Datenbank +}

      4.1.3.2. %::myconfig

      • Das einzige Hash unter den globalen Variablen

      • Wird spätestens benötigt wenn auf die Datenbank zugegriffen wird

      • Wird bei jedem Request neu erstellt.

      • Enthält die Userdaten des aktuellen Logins

      • Sollte nicht ohne Filterung irgendwo gedumpt werden oder extern serialisiert werden, weil da auch der Datenbankzugriff für diesen user drinsteht.

      • Enthält unter anderem Datumsformat dateformat und @@ -122,10 +122,10 @@ überwiegend die Daten, die sich unter Programm -> Einstellungen befinden, bzw. die Informationen über den Benutzer die über die - Administrator-Schnittstelle eingegeben wurden.

      4.1.3.3. $::locale

      • Objekt der Klasse "Locale"

      • Wird pro Request erstellt

      • Muss auch für Tests und Scripte immer verfügbar + Administrator-Schnittstelle eingegeben wurden.

      4.1.3.3. $::locale

      • Objekt der Klasse "Locale"

      • Wird pro Request erstellt

      • Muss auch für Tests und Scripte immer verfügbar sein.

      • Cached intern über Requestgrenzen hinweg benutzte Locales

      Lokalisierung für den aktuellen User. Alle Übersetzungen, - Zahlen- und Datumsformatierungen laufen über dieses Objekt.

      4.1.3.4. $::lxdebug

      • Objekt der Klasse "LXDebug"

      • Wird global gecached

      • Muss immer verfügbar sein, in nahezu allen + Zahlen- und Datumsformatierungen laufen über dieses Objekt.

      4.1.3.4. $::lxdebug

      • Objekt der Klasse "LXDebug"

      • Wird global gecached

      • Muss immer verfügbar sein, in nahezu allen Funktionen

      $::lxdebug stellt Debuggingfunktionen bereit, wie "enter_sub" und @@ -135,7 +135,7 @@ "message" und "dump" mit denen man flott Informationen ins Log (tmp/kivitendo-debug.log) packen kann.

      Beispielsweise so:

      $main::lxdebug->message(0, 'Meine Konfig:' . Dumper (%::myconfig));
-$main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{vc});

      4.1.3.5. $::auth

      • Objekt der Klasse "SL::Auth"

      • Wird global gecached

      • Hat eine permanente DB Verbindung zur Authdatenbank

      • Wird nach jedem Request resettet.

      +$main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{vc});

      4.1.3.5. $::auth

      • Objekt der Klasse "SL::Auth"

      • Wird global gecached

      • Hat eine permanente DB Verbindung zur Authdatenbank

      • Wird nach jedem Request resettet.

      $::auth stellt Funktionen bereit um die Rechte des aktuellen Users abzufragen. Obwohl diese Informationen vom aktuellen User abhängen wird das Objekt aus @@ -144,7 +144,7 @@ $main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{ Dessen Einstellungen können über $::auth->client abgefragt werden; Rückgabewert ist ein Hash mit den Werten aus der Tabelle - auth.clients.

      4.1.3.6. $::lx_office_conf

      • Objekt der Klasse + auth.clients.

      4.1.3.6. $::lx_office_conf

      • Objekt der Klasse "SL::LxOfficeConf"

      • Global gecached

      • Repräsentation der config/kivitendo.conf[.default]-Dateien

      Globale Konfiguration. Configdateien werden zum Start gelesen und danach nicht mehr angefasst. Es ist derzeit nicht geplant, dass @@ -154,16 +154,16 @@ $main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{ file_name = /tmp/kivitendo-debug.log

      ist der Key file im Programm als $::lx_office_conf->{debug}{file} erreichbar.

      [Warnung]Warnung

      Zugriff auf die Konfiguration erfolgt im Moment über - Hashkeys, sind also nicht gegen Tippfehler abgesichert.

      4.1.3.7. $::instance_conf

      • Objekt der Klasse + Hashkeys, sind also nicht gegen Tippfehler abgesichert.

    4.1.3.7. $::instance_conf

    • Objekt der Klasse "SL::InstanceConfiguration"

    • wird pro Request neu erstellt

    Funktioniert wie $::lx_office_conf, speichert aber Daten die von der Instanz abhängig sind. Eine Instanz ist hier eine Mandantendatenbank. Beispielsweise überprüft 

    $::instance_conf->get_inventory_system eq 'perpetual'

    - ob die berüchtigte Bestandsmethode zur Anwendung kommt.

    4.1.3.8. $::dispatcher

    • Objekt der Klasse + ob die berüchtigte Bestandsmethode zur Anwendung kommt.

    4.1.3.8. $::dispatcher

    • Objekt der Klasse "SL::Dispatcher"

    • wird pro Serverprozess erstellt.

    • enthält Informationen über die technische Verbindung zum Server

    Der dritte Punkt ist auch der einzige Grund warum das Objekt global gespeichert wird. Wird vermutlich irgendwann in einem anderen - Objekt untergebracht.

    4.1.3.9. $::request

    • Hashref (evtl später Objekt)

    • Wird pro Request neu initialisiert.

    • Keine Unterstruktur garantiert.

    + Objekt untergebracht.

    4.1.3.9. $::request

    • Hashref (evtl später Objekt)

    • Wird pro Request neu initialisiert.

    • Keine Unterstruktur garantiert.

    $::request ist ein generischer Platz um Daten "für den aktuellen Request" abzulegen. Sollte nicht für action at a distance benutzt werden, sondern um lokales memoizing zu @@ -176,20 +176,20 @@ file_name = /tmp/kivitendo-debug.log

    ist der Key f $::request

  • Muss ich von anderen Teilen des Programms lesend drauf zugreifen? Dann $::request, aber Zugriff über - Wrappermethode

    • 4.1.4. Ehemalige globale Variablen

    Die folgenden Variablen waren einmal im Programm, und wurden - entfernt.

    4.1.4.1. $::cgi

    • war nötig, weil cookie Methoden nicht als + Wrappermethode

    4.1.4. Ehemalige globale Variablen

    Die folgenden Variablen waren einmal im Programm, und wurden + entfernt.

    4.1.4.1. $::cgi

    • war nötig, weil cookie Methoden nicht als Klassenfunktionen funktionieren

    • Aufruf als Klasse erzeugt Dummyobjekt was im Klassennamespace gehalten wird und über Requestgrenzen leaked

    • liegt jetzt unter $::request->{cgi} -

    4.1.4.2. $::all_units

    • war nötig, weil einige Funktionen in Schleifen zum Teil +

    4.1.4.2. $::all_units

    • war nötig, weil einige Funktionen in Schleifen zum Teil ein paar hundert mal pro Request eine Liste der Einheiten brauchen, und de als Parameter durch einen Riesenstack von Funktionen geschleift werden müssten.

    • Liegt jetzt unter $::request->{cache}{all_units}

    • Wird nur in AM->retrieve_all_units() gesetzt oder - gelesen.

    4.1.4.3. %::called_subs

    • wurde benutzt um callsub deep recursions + gelesen.

    4.1.4.3. %::called_subs

    • wurde benutzt um callsub deep recursions abzufangen.

    • Wurde entfernt, weil callsub nur einen Bruchteil der möglichen Rekursioenen darstellt, und da nie welche auftreten.

    • komplette recursion protection wurde entfernt.

    Zurück   Weiter
    3.9. Webshop-Api Zum Anfang 4.2. Entwicklung unter FastCGI
    \ No newline at end of file diff --git a/doc/html/index.html b/doc/html/index.html index 45d5ad6ad..78c10269c 100644 --- a/doc/html/index.html +++ b/doc/html/index.html @@ -2,8 +2,8 @@ kivitendo 3.5.1: Installation, Konfiguration, Entwicklung
    kivitendo 3.5.1: Installation, Konfiguration, Entwicklung
       Weiter

    kivitendo 3.5.1: Installation, Konfiguration, - Entwicklung

    Inhaltsverzeichnis

    1. Aktuelle Hinweise
    2. Installation und Grundkonfiguration
    2.1. Übersicht
    2.2. Benötigte Software und Pakete
    2.2.1. Betriebssystem
    2.2.2. Benötigte Perl-Pakete installieren
    2.2.3. Andere Pakete installieren
    2.3. Manuelle Installation des Programmpaketes
    2.4. kivitendo-Konfigurationsdatei
    2.4.1. Einführung
    2.4.2. Abschnitte und Parameter
    2.4.3. Versionen vor 2.6.3
    2.5. Anpassung der PostgreSQL-Konfiguration
    2.5.1. Zeichensätze/die Verwendung von Unicode/UTF-8
    2.5.2. Änderungen an Konfigurationsdateien
    2.5.3. Erweiterung für servergespeicherte Prozeduren
    2.5.4. Erweiterung für Trigram Prozeduren
    2.5.5. Datenbankbenutzer anlegen
    2.6. Webserver-Konfiguration
    2.6.1. Grundkonfiguration mittels CGI
    2.6.2. Konfiguration für FastCGI/FCGI
    2.6.3. Weitergehende Konfiguration
    2.7. Der Task-Server
    2.7.1. Verfügbare und notwendige Konfigurationsoptionen
    2.7.2. Konfiguration der Mandanten für den Task-Server
    2.7.3. Automatisches Starten des Task-Servers beim Booten
    2.7.4. Wie der Task-Server gestartet und beendet wird
    2.8. Benutzerauthentifizierung und Administratorpasswort
    2.8.1. Grundlagen zur Benutzerauthentifizierung
    2.8.2. Administratorpasswort
    2.8.3. Authentifizierungsdatenbank
    2.8.4. Passwortüberprüfung
    2.8.5. Name des Session-Cookies
    2.8.6. Anlegen der Authentifizierungsdatenbank
    2.9. Mandanten-, Benutzer- und Gruppenverwaltung
    2.9.1. Zusammenhänge
    2.9.2. Mandanten, Benutzer und Gruppen
    2.9.3. Datenbanken anlegen
    2.9.4. Gruppen anlegen
    2.9.5. Benutzer anlegen
    2.9.6. Mandanten anlegen
    2.10. Drucker- und Systemverwaltung
    2.10.1. Druckeradministration
    2.10.2. System sperren / entsperren
    2.11. E-Mail-Versand aus kivitendo heraus
    2.11.1. Versand über lokalen E-Mail-Server
    2.11.2. Versand über einen SMTP-Server
    2.12. Drucken mit kivitendo
    2.12.1. Vorlagenverzeichnis anlegen
    2.12.2. Der Druckvorlagensatz RB
    2.12.3. f-tex
    2.12.4. Der Druckvorlagensatz rev-odt
    2.12.5. Allgemeine Hinweise zu LaTeX Vorlagen
    2.13. OpenDocument-Vorlagen
    2.13.1. OpenDocument (odt) Druckvorlagen mit Makros
    2.14. Nomenklatur
    2.14.1. Datum bei Buchungen
    2.15. Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung: + Entwicklung

    Inhaltsverzeichnis

    1. Aktuelle Hinweise
    2. Installation und Grundkonfiguration
    2.1. Übersicht
    2.2. Benötigte Software und Pakete
    2.2.1. Betriebssystem
    2.2.2. Benötigte Perl-Pakete installieren
    2.2.3. Andere Pakete installieren
    2.3. Manuelle Installation des Programmpaketes
    2.4. kivitendo-Konfigurationsdatei
    2.4.1. Einführung
    2.4.2. Abschnitte und Parameter
    2.4.3. Versionen vor 2.6.3
    2.5. Anpassung der PostgreSQL-Konfiguration
    2.5.1. Zeichensätze/die Verwendung von Unicode/UTF-8
    2.5.2. Änderungen an Konfigurationsdateien
    2.5.3. Erweiterung für servergespeicherte Prozeduren
    2.5.4. Erweiterung für Trigram Prozeduren
    2.5.5. Datenbankbenutzer anlegen
    2.6. Webserver-Konfiguration
    2.6.1. Grundkonfiguration mittels CGI
    2.6.2. Konfiguration für FastCGI/FCGI
    2.6.3. Weitergehende Konfiguration
    2.7. Der Task-Server
    2.7.1. Verfügbare und notwendige Konfigurationsoptionen
    2.7.2. Konfiguration der Mandanten für den Task-Server
    2.7.3. Automatisches Starten des Task-Servers beim Booten
    2.7.4. Wie der Task-Server gestartet und beendet wird
    2.8. Benutzerauthentifizierung und Administratorpasswort
    2.8.1. Grundlagen zur Benutzerauthentifizierung
    2.8.2. Administratorpasswort
    2.8.3. Authentifizierungsdatenbank
    2.8.4. Passwortüberprüfung
    2.8.5. Name des Session-Cookies
    2.8.6. Anlegen der Authentifizierungsdatenbank
    2.9. Mandanten-, Benutzer- und Gruppenverwaltung
    2.9.1. Zusammenhänge
    2.9.2. Mandanten, Benutzer und Gruppen
    2.9.3. Datenbanken anlegen
    2.9.4. Gruppen anlegen
    2.9.5. Benutzer anlegen
    2.9.6. Mandanten anlegen
    2.10. Drucker- und Systemverwaltung
    2.10.1. Druckeradministration
    2.10.2. System sperren / entsperren
    2.11. E-Mail-Versand aus kivitendo heraus
    2.11.1. Versand über lokalen E-Mail-Server
    2.11.2. Versand über einen SMTP-Server
    2.12. Drucken mit kivitendo
    2.12.1. Vorlagenverzeichnis anlegen
    2.12.2. Der Druckvorlagensatz RB
    2.12.3. f-tex
    2.12.4. Der Druckvorlagensatz rev-odt
    2.12.5. Allgemeine Hinweise zu LaTeX Vorlagen
    2.13. OpenDocument-Vorlagen
    2.13.1. OpenDocument (odt) Druckvorlagen mit Makros
    2.14. Nomenklatur
    2.14.1. Datum bei Buchungen
    2.15. Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung: EUR
    2.15.1. Einführung
    2.15.2. Konfigurationsparameter
    2.15.3. Festlegen der Parameter
    2.15.4. Bemerkungen zur Bestandsmethode
    2.15.5. Bekannte Probleme
    2.16. SKR04 19% Umstellung für innergemeinschaftlichen Erwerb
    2.16.1. Einführung
    2.16.2. Konto 3804 manuell anlegen
    2.17. Verhalten des Bilanzberichts
    2.18. Erfolgsrechnung
    2.19. Rundung in Verkaufsbelegen
    2.20. Einstellungen pro Mandant
    2.21. kivitendo ERP verwenden
    3. Features und Funktionen
    3.1. Wiederkehrende Rechnungen
    3.1.1. Einführung
    3.1.2. Konfiguration
    3.1.3. Spezielle Variablen
    3.1.4. Auflisten
    3.1.5. Erzeugung der eigentlichen Rechnungen
    3.1.6. Erste Rechnung für aktuellen Monat erstellen
    3.2. Bankerweiterung
    3.2.1. Einführung
    3.3. Dokumentenvorlagen und verfügbare Variablen
    3.3.1. Einführung
    3.3.2. Variablen ausgeben
    3.3.3. Verwendung in Druckbefehlen
    3.3.4. Anfang und Ende der Tags verändern
    3.3.5. Zuordnung von den Dateinamen zu den Funktionen
    3.3.6. Sprache, Drucker und E-Mail
    3.3.7. Allgemeine Variablen, die in allen Vorlagen vorhanden sind
    3.3.8. Variablen in Rechnungen
    3.3.9. Variablen in Mahnungen und Rechnungen über Mahngebühren
    3.3.10. Variablen in anderen Vorlagen
    3.3.11. Blöcke, bedingte Anweisungen und Schleifen
    3.3.12. Markup-Code zur Textformatierung innerhalb von - Formularen
    3.4. Excel-Vorlagen
    3.4.1. Zusammenfassung
    3.4.2. Bedienung
    3.4.3. Variablensyntax
    3.4.4. Einschränkungen
    3.5. Mandantenkonfiguration Lager
    3.6. Schweizer Kontenpläne
    3.7. Artikelklassifizierung
    3.7.1. Übersicht
    3.7.2. Basisklassifizierung
    3.7.3. Attribute
    3.7.4. Zwei-Zeichen Abkürzung
    3.8. Dateiverwaltung (Mini-DMS)
    3.8.1. Übersicht
    3.8.2. Struktur
    3.8.3. Anwendung
    3.8.4. Konfigurierung
    3.9. Webshop-Api
    3.9.1. Rechte für die Webshopapi
    3.9.2. Konfiguration
    3.9.3. Webshopartikel
    3.9.4. Bestellimport
    3.9.5. Mapping der Daten
    4. Entwicklerdokumentation
    4.1. Globale Variablen
    4.1.1. Wie sehen globale Variablen in Perl aus?
    4.1.2. Warum sind globale Variablen ein Problem?
    4.1.3. Kanonische globale Variablen
    4.1.4. Ehemalige globale Variablen
    4.2. Entwicklung unter FastCGI
    4.2.1. Allgemeines
    4.2.2. Programmende und Ausnahmen
    4.2.3. Globale Variablen
    4.2.4. Performance und Statistiken
    4.3. SQL-Upgradedateien
    4.3.1. Einführung
    4.3.2. Format der Kontrollinformationen
    4.3.3. Format von in Perl geschriebenen + Formularen
    3.4. Excel-Vorlagen
    3.4.1. Zusammenfassung
    3.4.2. Bedienung
    3.4.3. Variablensyntax
    3.4.4. Einschränkungen
    3.5. Mandantenkonfiguration Lager
    3.6. Schweizer Kontenpläne
    3.7. Artikelklassifizierung
    3.7.1. Übersicht
    3.7.2. Basisklassifizierung
    3.7.3. Attribute
    3.7.4. Zwei-Zeichen Abkürzung
    3.8. Dateiverwaltung (Mini-DMS)
    3.8.1. Übersicht
    3.8.2. Struktur
    3.8.3. Anwendung
    3.8.4. Konfigurierung
    3.9. Webshop-Api
    3.9.1. Rechte für die Webshopapi
    3.9.2. Konfiguration
    3.9.3. Webshopartikel
    3.9.4. Bestellimport
    3.9.5. Mapping der Daten
    4. Entwicklerdokumentation
    4.1. Globale Variablen
    4.1.1. Wie sehen globale Variablen in Perl aus?
    4.1.2. Warum sind globale Variablen ein Problem?
    4.1.3. Kanonische globale Variablen
    4.1.4. Ehemalige globale Variablen
    4.2. Entwicklung unter FastCGI
    4.2.1. Allgemeines
    4.2.2. Programmende und Ausnahmen
    4.2.3. Globale Variablen
    4.2.4. Performance und Statistiken
    4.3. SQL-Upgradedateien
    4.3.1. Einführung
    4.3.2. Format der Kontrollinformationen
    4.3.3. Format von in Perl geschriebenen Datenbankupgradescripten
    4.3.4. Hilfsscript dbupgrade2_tool.pl
    4.4. Translations and languages
    4.4.1. Introduction
    4.4.2. Character set
    4.4.3. File structure
    4.5. Die kivitendo-Test-Suite
    4.5.1. Einführung
    4.5.2. Voraussetzungen
    4.5.3. Existierende Tests ausführen
    4.5.4. Bedeutung der verschiedenen Test-Scripte
    4.5.5. Neue Test-Scripte erstellen
    4.6. Stil-Richtlinien
    4.7. Dokumentation erstellen
    4.7.1. Einführung
    4.7.2. Benötigte Software
    4.7.3. PDFs und HTML-Seiten erstellen
    4.7.4. Einchecken in das Git-Repository
       Weiter
       Kapitel 1. Aktuelle Hinweise
    \ No newline at end of file diff --git a/doc/kivitendo-Dokumentation.pdf b/doc/kivitendo-Dokumentation.pdf index f678a60f5..3e067acc6 100644 Binary files a/doc/kivitendo-Dokumentation.pdf and b/doc/kivitendo-Dokumentation.pdf differ diff --git a/modules/fallback/Daemon/Generic.pm b/modules/fallback/Daemon/Generic.pm deleted file mode 100644 index c185e8ae6..000000000 --- a/modules/fallback/Daemon/Generic.pm +++ /dev/null @@ -1,553 +0,0 @@ - -# Copyright (C) 2006, David Muir Sharnoff - -package Daemon::Generic; - -use strict; -use warnings; -require Exporter; -require POSIX; -use Getopt::Long; -use File::Slurp; -use File::Flock; -our @ISA = qw(Exporter); -our @EXPORT = qw(newdaemon); - -our $VERSION = 0.71; - -our $force_quit_delay = 15; -our $package = __PACKAGE__; -our $caller; - -sub newdaemon -{ - my (%args) = @_; - my $pkg = $caller || caller() || 'main'; - - my $foo = bless {}, $pkg; - - unless ($foo->isa($package)) { - no strict qw(refs); - my $isa = \@{"${pkg}::ISA"}; - unshift(@$isa, $package); - } - - bless $foo, 'This::Package::Does::Not::Exist'; - undef $foo; - - new($pkg, %args); -} - -sub new -{ - my ($pkg, %args) = @_; - - if ($pkg eq __PACKAGE__) { - $pkg = caller() || 'main'; - } - - srand(time ^ ($$ << 5)) - unless $args{no_srand}; - - my $av0 = $0; - $av0 =~ s!/!/.!g; - - my $self = { - gd_args => \%args, - gd_pidfile => $args{pidfile}, - gd_logpriority => $args{logpriority}, - gd_progname => $args{progname} - ? $args{progname} - : $0, - gd_pidbase => $args{pidbase} - ? $args{pidbase} - : ($args{progname} - ? "/var/run/$args{progname}" - : "/var/run/$av0"), - gd_foreground => $args{foreground} || 0, - configfile => $args{configfile} - ? $args{configfile} - : ($args{progname} - ? "/etc/$args{progname}.conf" - : "/etc/$av0"), - debug => $args{debug} || 0, - }; - bless $self, $pkg; - - $self->gd_getopt; - $self->gd_parse_argv; - - my $do = $self->{do} = $ARGV[0]; - - $self->gd_help if $do eq 'help'; - $self->gd_version if $do eq 'version'; - $self->gd_install if $do eq 'install'; - $self->gd_uninstall if $do eq 'uninstall'; - - $self->gd_pidfile unless $self->{gd_pidfile}; - - my %newconfig = $self->gd_preconfig; - - $self->{gd_pidfile} = $newconfig{pidfile} if $newconfig{pidfile}; - - print "Configuration looks okay\n" if $do eq 'check'; - - my $pidfile = $self->{gd_pidfile}; - my $killed = 0; - my $locked = 0; - if (-e $pidfile) { - if ($locked = lock($pidfile, undef, 'nonblocking')) { - # old process is dead - if ($do eq 'status') { - print "$0 dead\n"; - exit 1; - } - } else { - sleep(2) if -M $pidfile < 2/86400; - my $oldpid = read_file($pidfile); - chomp($oldpid); - if ($oldpid) { - if ($do eq 'stop' or $do eq 'restart') { - $killed = $self->gd_kill($oldpid); - $locked = lock($pidfile); - if ($do eq 'stop') { - unlink($pidfile); - exit; - } - } elsif ($do eq 'reload') { - if (kill(1,$oldpid)) { - print "Requested reconfiguration\n"; - exit; - } else { - print "Kill failed: $!\n"; - } - } elsif ($do eq 'status') { - if (kill(0,$oldpid)) { - print "$0 running - pid $oldpid\n"; - $self->gd_check($pidfile, $oldpid); - exit 0; - } else { - print "$0 dead\n"; - exit 1; - } - } elsif ($do eq 'check') { - if (kill(0,$oldpid)) { - print "$0 running - pid $oldpid\n"; - $self->gd_check($pidfile, $oldpid); - exit; - } - } elsif ($do eq 'start') { - print "\u$self->{gd_progname} is already running (pid $oldpid)\n"; - exit; # according to LSB, this is no error - } - } else { - $self->gd_error("Pid file $pidfile is invalid but locked, exiting\n"); - } - } - } else { - $locked = lock($pidfile, undef, 'nonblocking') - or die "Could not lock pid file $pidfile: $!"; - } - - if ($do eq 'reload' || $do eq 'stop' || $do eq 'check' || ($do eq 'restart' && ! $killed)) { - print "No $0 running\n"; - } - - if ($do eq 'stop') { - unlink($pidfile); - exit; - } - - if ($do eq 'status') { - print "Unused\n"; - exit 3; - } - - if ($do eq 'check') { - $self->gd_check($pidfile); - exit - } - - unless ($do eq 'reload' || $do eq 'restart' || $do eq 'start') { - $self->gd_other_cmd($do, $locked); - } - - unless ($self->{gd_foreground}) { - $self->gd_daemonize; - } - - $locked or lock($pidfile, undef, 'nonblocking') - or die "Could not lock PID file $pidfile: $!"; - - write_file($pidfile, "$$\n"); - - print STDERR "Starting up...\n"; - - $self->gd_postconfig(%newconfig); - - $self->gd_setup_signals; - - $self->gd_run; - - unlink($pidfile); - exit(0); -} - -sub gd_check {} - -sub gd_more_opt { return() } - -sub gd_getopt -{ - my $self = shift; - Getopt::Long::Configure("auto_version"); - GetOptions( - 'configfile=s' => \$self->{configfile}, - 'foreground!' => \$self->{gd_foreground}, - 'debug!' => \$self->{debug}, - $self->{gd_args}{options} - ? %{$self->{gd_args}{options}} - : (), - $self->gd_more_opt(), - ) or exit($self->gd_usage()); - - if (@ARGV < ($self->{gd_args}{minimum_args} || 1)) { - exit($self->gd_usage()); - } - if (@ARGV > ($self->{gd_args}{maximum_args} || 1)) { - exit($self->gd_usage()); - } -} - -sub gd_parse_argv { } - -sub gd_help -{ - my $self = shift; - exit($self->gd_usage($self->{gd_args})); -} - -sub gd_version -{ - my $self = shift; - no strict qw(refs); - my $v = $self->{gd_args}{version} - || ${ref($self)."::VERSION"} - || $::VERSION - || $main::VERSION - || "?"; - print "$self->{gd_progname} - version $v\n";; - exit; -} - -sub gd_pidfile -{ - my $self = shift; - my $x = $self->{configfile}; - $x =~ s!/!.!g; - $self->{gd_pidfile} = "$self->{gd_pidbase}$x.pid"; -} - -sub gd_other_cmd -{ - my $self = shift; - $self->gd_usage; - exit(1); -} - -sub gd_redirect_output -{ - my $self = shift; - return if $self->{gd_foreground}; - my $logname = $self->gd_logname; - my $p = $self->{gd_logpriority} ? "-p $self->{gd_logpriority}" : ""; - open(STDERR, "|logger $p -t '$logname'") or (print "could not open stderr: $!" && exit(1)); - close(STDOUT); - open(STDOUT, ">&STDERR") or die "redirect STDOUT -> STDERR: $!"; - close(STDIN); -} - -sub gd_daemonize -{ - my $self = shift; - print "Starting $self->{gd_progname} server\n"; - $self->gd_redirect_output(); - my $pid; - POSIX::_exit(0) if $pid = fork; - die "Could not fork: $!" unless defined $pid; - POSIX::_exit(0) if $pid = fork; - die "Could not fork: $!" unless defined $pid; - - POSIX::setsid(); - select(STDERR); - $| = 1; - print "Sucessfully daemonized\n"; -} - -sub gd_logname -{ - my $self = shift; - return $self->{gd_progname}."[$$]"; -} - -sub gd_reconfig_event -{ - my $self = shift; - print STDERR "Reconfiguration requested\n"; - $self->gd_postconfig($self->gd_preconfig()); -} - -sub gd_quit_event -{ - my $self = shift; - print STDERR "Quitting...\n"; - exit(0); -} - -sub gd_setup_signals -{ - my $self = shift; - $SIG{INT} = sub { $self->gd_quit_event() }; - $SIG{HUP} = sub { $self->gd_reconfig_event() }; -} - -sub gd_run { die "must defined gd_run()" } - -sub gd_error -{ - my $self = shift; - my $e = shift; - my $do = $self->{do}; - if ($do && $do eq 'stop') { - warn $e; - } else { - die $e; - } -} - -sub gd_flags_more { return () } - -sub gd_flags -{ - my $self = shift; - return ( - '-c file' => "Specify configuration file (instead of $self->{configfile})", - '-f' => "Run in the foreground (don't detach)", - $self->gd_flags_more - ); -} - -sub gd_commands_more { return () } - -sub gd_commands -{ - my $self = shift; - return ( - start => "Starts a new $self->{gd_progname} if there isn't one running already", - stop => "Stops a running $self->{gd_progname}", - reload => "Causes a running $self->{gd_progname} to reload it's config file. Starts a new one if none is running.", - restart => "Stops a running $self->{gd_progname} if one is running. Starts a new one.", - $self->gd_commands_more(), - ($self->gd_can_install() - ? ('install' => "Setup $self->{gd_progname} to run automatically after reboot") - : ()), - ($self->gd_can_uninstall() - ? ('uninstall' => "Do not run $self->{gd_progname} after reboots") - : ()), - check => "Check the configuration file and report the daemon state", - help => "Display this usage info", - version => "Display the version of $self->{gd_progname}", - ) -} - -sub gd_positional_more { return() } - -sub gd_alts -{ - my $offset = shift; - my @results; - for (my $i = $offset; $i <= $#_; $i += 2) { - push(@results, $_[$i]); - } - return @results; -} - -sub gd_usage -{ - my $self = shift; - - require Text::Wrap; - import Text::Wrap; - - my $col = 15; - - my @flags = $self->gd_flags; - my @commands = $self->gd_commands; - my @positional = $self->gd_positional_more; - - my $summary = "Usage: $self->{gd_progname} "; - my $details = ''; - for my $i (gd_alts(0, @flags)) { - $summary .= "[ $i ] "; - } - $summary .= "{ "; - $summary .= join(" | ", gd_alts(0, @commands)); - $summary .= " } "; - $summary .= join(" ", gd_alts(0, @positional)); - - my (@all) = (@flags, @commands, @positional); - while (@all) { - my ($key, $desc) = splice(@all, 0, 2); - local($Text::Wrap::columns) = 79; - $details .= wrap( - sprintf(" %-${col}s ", $key), - " " x ($col + 2), - $desc); - $details .= "\n"; - } - - print "$summary\n$details"; - return 0; -} - -sub gd_install_pre {} -sub gd_install_post {} - -sub gd_can_install -{ - my $self = shift; - require File::Basename; - my $basename = File::Basename::basename($0); - if ( - -x "/usr/sbin/update-rc.d" - && - -x $0 - && - $0 !~ m{^(?:/usr|/var)?/tmp/} - && - eval { symlink("",""); 1 } - && - -d "/etc/init.d" - && - ! -e "/etc/init.d/$basename" - ) { - return sub { - $self->gd_install_pre("update-rc.d"); - require Cwd; - my $abs_path = Cwd::abs_path($0); - symlink($abs_path, "/etc/init.d/$basename") - or die "Install failed: symlink /etc/init.d/$basename -> $abs_path: $!\n"; - print "+ /usr/sbin/update-rc.d $basename defaults\n"; - system("/usr/sbin/update-rc.d", $basename, "defaults"); - my $exit = $? >> 8; - $self->gd_install_post("update-rc.d"); - exit($exit) if $exit; - }; - } - - return 0; -} - -sub gd_install -{ - my $self = shift; - my $ifunc = $self->gd_can_install(); - die "Install command not supported\n" unless $ifunc; - &$ifunc($self); - exit(0); -} - -sub gd_uninstall_pre {} -sub gd_uninstall_post {} - -sub gd_can_uninstall -{ - my $self = shift; - require File::Basename; - my $basename = File::Basename::basename($0); - require Cwd; - my $abs_path = Cwd::abs_path($0) || 'no abs path'; - my $link = readlink("/etc/init.d/$basename") || 'no link'; - if ( - $link eq $abs_path - && - -x "/usr/sbin/update-rc.d" - ) { - return sub { - $self->gd_uninstall_pre("update-rc.d"); - unlink("/etc/init.d/$basename"); - print "+ /usr/sbin/update-rc.d $basename remove\n"; - system("/usr/sbin/update-rc.d", $basename, "remove"); - my $exit = $? >> 8; - $self->gd_uninstall_post("update-rc.d"); - exit($exit) if $exit; - } - } - return 0; -} - -sub gd_uninstall -{ - my $self = shift; - my $ufunc = $self->gd_can_uninstall(); - die "Cannot uninstall\n" unless $ufunc; - &$ufunc($self); - exit(0); -} - -sub gd_kill -{ - my ($self, $pid) = @_; - - my $talkmore = 0; - my $killed = 0; - if (kill(0, $pid)) { - $killed = 1; - kill(2,$pid); - print "Killing $pid\n"; - my $t = time; - sleep(1) if kill(0, $pid); - if ($force_quit_delay && kill(0, $pid)) { - print "Waiting for $pid to die...\n"; - $talkmore = 1; - while(kill(0, $pid) && time - $t < $force_quit_delay) { - sleep(1); - } - } - if (kill(15, $pid)) { - print "Killing $pid with -TERM...\n"; - if ($force_quit_delay) { - while(kill(0, $pid) && time - $t < $force_quit_delay * 2) { - sleep(1); - } - } else { - sleep(1) if kill(0, $pid); - } - } - if (kill(9, $pid)) { - print "Killing $pid with -KILL...\n"; - my $k9 = time; - my $max = $force_quit_delay * 4; - $max = 60 if $max < 60; - while(kill(0, $pid)) { - if (time - $k9 > $max) { - print "Giving up on $pid ever dying.\n"; - exit(1); - } - print "Waiting for $pid to die...\n"; - sleep(1); - } - } - print "Process $pid is gone\n" if $talkmore; - } else { - print "Process $pid no longer running\n"; - } - return $killed; -} - -sub gd_preconfig { die "gd_preconfig() must be redefined"; } - -sub gd_postconfig { } - - -1; diff --git a/modules/fallback/Daemon/Generic/Event.pm b/modules/fallback/Daemon/Generic/Event.pm deleted file mode 100644 index 2279a1ee9..000000000 --- a/modules/fallback/Daemon/Generic/Event.pm +++ /dev/null @@ -1,126 +0,0 @@ - -# Copyright (C) 2006, David Muir Sharnoff - -package Daemon::Generic::Event; - -use strict; -use warnings; -require Daemon::Generic; -require Event; -require Exporter; - -our @ISA = qw(Daemon::Generic Exporter); -our @EXPORT = @Daemon::Generic::EXPORT; -our $VERSION = 0.3; - -sub newdaemon -{ - local($Daemon::Generic::caller) = caller() || 'main'; - local($Daemon::Generic::package) = __PACKAGE__; - Daemon::Generic::newdaemon(@_); -} - -sub gd_setup_signals -{ - my $self = shift; - my $reload_event = Event->signal( - signal => 'HUP', - desc => 'reload on SIGHUP', - prio => 6, - cb => sub { - $self->gd_reconfig_event; - $self->{gd_timer}->cancel() - if $self->{gd_timer}; - $self->gd_setup_timer(); - }, - ); - my $quit_event = Event->signal( - signal => 'INT', - cb => sub { $self->gd_quit_event; }, - ); -} - -sub gd_setup_timer -{ - my $self = shift; - if ($self->can('gd_run_body')) { - my $interval = ($self->can('gd_interval') && $self->gd_interval()) || 1; - $self->{gd_timer} = Event->timer( - cb => [ $self, 'gd_run_body' ], - interval => $interval, - hard => 0, - ); - } -} - -sub gd_run -{ - my $self = shift; - $self->gd_setup_timer(); - Event::loop(); -} - -sub gd_quit_event -{ - my $self = shift; - print STDERR "Quitting...\n"; - Event::unloop_all(); -} - -1; - -=head1 NAME - - Daemon::Generic::Event - Generic daemon framework with Event.pm - -=head1 SYNOPSIS - - use Daemon::Generic::Event; - - @ISA = qw(Daemon::Generic::Event); - - sub gd_preconfig { - # stuff - } - -=head1 DESCRIPTION - -Daemon::Generic::Event is a subclass of L that -predefines some methods: - -=over 15 - -=item gd_run() - -Setup a periodic callback to C if there is a C. -Call C. - -=item gd_setup_signals() - -Bind SIGHUP to call C. -Bind SIGINT to call C. - -=back - -To use Daemon::Generic::Event, you have to provide a C -method. It can be empty if you have a C. - -Set up your own events in C and C. - -If you have a C method, it will be called once per -second or every C seconds if you have a C -method. Unlike in L, C should -not include a call to C. - -=head1 THANK THE AUTHOR - -If you need high-speed internet services (T1, T3, OC3 etc), please -send me your request-for-quote. I have access to very good pricing: -you'll save money and get a great service. - -=head1 LICENSE - -Copyright(C) 2006 David Muir Sharnoff . -This module may be used and distributed on the same terms -as Perl itself. - diff --git a/modules/fallback/Daemon/Generic/While1.pm b/modules/fallback/Daemon/Generic/While1.pm deleted file mode 100644 index 9c2691449..000000000 --- a/modules/fallback/Daemon/Generic/While1.pm +++ /dev/null @@ -1,189 +0,0 @@ -# Copyright (C) 2006, David Muir Sharnoff - -package Daemon::Generic::While1; - -use strict; -use warnings; -use Carp; -require Daemon::Generic; -require POSIX; -require Exporter; - -our @ISA = qw(Daemon::Generic Exporter); -our @EXPORT = @Daemon::Generic::EXPORT; -our $VERSION = 0.3; - -sub newdaemon -{ - local($Daemon::Generic::caller) = caller() || 'main'; - local($Daemon::Generic::package) = __PACKAGE__; - Daemon::Generic::newdaemon(@_); -} - -sub gd_setup_signals -{ - my ($self) = @_; - $SIG{HUP} = sub { - $self->{gd_sighup} = time; - }; - my $child; - $SIG{INT} = sub { - $self->{gd_sigint} = time; - # - # We'll be getting a SIGTERM in a bit if we're not dead, so let's use it. - # - $SIG{TERM} = sub { - $self->gd_quit_event(); - kill(15, $child) if $child; # if we're still alive, let's stay that way - }; - }; -} - -sub gd_sleep -{ - my ($self, $period) = @_; - croak "Sleep period must be defined" unless defined $period; - my $hires; - if ($period*1000 != int($period*1000)) { - $hires = 1; - require Time::HiRes; - import Time::HiRes qw(time sleep); - } - my $t = time; - while (time - $t < $period) { - return if $self->{gd_sigint}; - return if $self->{gd_sighup}; - if ($hires) { - my $p = (time - $t < 1) - ? time - $t - : 1; - sleep($p); - } else { - sleep(1); - } - } -} - -sub gd_run -{ - my ($self) = @_; - while(1) { - if ($self->{gd_sigint}) { - $self->{gd_sigint} = 0; - $self->gd_quit_event(); - } - - if ($self->{gd_sighup}) { - $self->{gd_sighup} = 0; - $self->gd_reconfig_event(); - } - - $self->gd_run_body(); - } -} - -sub gd_reconfig_event -{ - my $self = shift; - print STDERR "Reconfiguration requested\n"; - $self->gd_postconfig($self->gd_preconfig()); -} - -sub gd_quit_event -{ - print STDERR "Quitting...\n"; - exit(0); -} - - -sub gd_run_body { die "must override gd_run_body()" } - -1; - -=head1 NAME - - Daemon::Generic::While1 - Daemon framework with default while(1) loop - -=head1 SYNOPSIS - - @ISA = qw(Daemon::Generic::While1); - - sub gd_run_body { - # stuff - } - -=head1 DESCRIPTION - -This is a slight variation on L: a default -C provided. It has a while(1) loop that calls -C over and over. It checks for reconifg and -and terminate events and only actions them between calls -to C. - -Terminate events will be forced through after -C<$Daemon::Generic::force_quit_delay> seconds if -C doesn't return quickly enough. - -=head1 SUBCLASS METHODS REQUIRD - -The following method is required to be overridden to subclass -Daemon::Generic::While1: - -=over 15 - -=item gd_run_body() - -This method will be called over and over. This method should -include a call to C (or a bit more). Reconfig events -will not interrupt it. Quit events will only interrupt it -after 15 seconds. - -=back - -=head1 ADDITIONAL METHODS - -The following additional methods are available for your use -(as compared to L): - -=over 15 - -=item gd_sleep($period) - -This will sleep for C<$period> seconds but in one-second -intervals so that if a SIGINT or SIGHUP arrives the sleep -period can end more quickly. - -Using this makes it safe for C to sleep for -longer than C<$Daemon::Generic::force_quit_delay> seconds -at a time. - -=back - -=head1 ADDITIONAL MEMBER DATA - -The following additional bits of member data are defined: - -=over 15 - -=item gd_sigint - -The time at which an (unprocessed) SIGINT was recevied. - -=item gd_sighup - -The time at which an (unprocessed) SIGHUP was recevied. - -=back - -=head1 THANK THE AUTHOR - -If you need high-speed internet services (T1, T3, OC3 etc), please -send me your request-for-quote. I have access to very good pricing: -you'll save money and get a great service. - -=head1 LICENSE - -Copyright(C) 2006 David Muir Sharnoff . -This module may be used and distributed on the same terms -as Perl itself. - diff --git a/modules/fallback/File/Flock.pm b/modules/fallback/File/Flock.pm deleted file mode 100644 index f9b62c184..000000000 --- a/modules/fallback/File/Flock.pm +++ /dev/null @@ -1,327 +0,0 @@ -# Copyright (C) 1996, 1998 David Muir Sharnoff - -package File::Flock; - -require Exporter; -@ISA = qw(Exporter); -@EXPORT = qw(lock unlock lock_rename); - -use Carp; -use POSIX qw(EAGAIN EACCES EWOULDBLOCK ENOENT EEXIST O_EXCL O_CREAT O_RDWR); -use Fcntl qw(LOCK_SH LOCK_EX LOCK_NB LOCK_UN); -use IO::File; - -use vars qw($VERSION $debug $av0debug); - -BEGIN { - $VERSION = 2008.01; - $debug = 0; - $av0debug = 0; -} - -use strict; -no strict qw(refs); - -my %locks; # did we create the file? -my %lockHandle; -my %shared; -my %pid; -my %rm; - -sub new -{ - my ($pkg, $file, $shared, $nonblocking) = @_; - &lock($file, $shared, $nonblocking) or return undef; - return bless \$file, $pkg; -} - -sub DESTROY -{ - my ($this) = @_; - unlock($$this); -} - -sub lock -{ - my ($file, $shared, $nonblocking) = @_; - - my $f = new IO::File; - - my $created = 0; - my $previous = exists $locks{$file}; - - # the file may be springing in and out of existance... - OPEN: - for(;;) { - if (-e $file) { - unless (sysopen($f, $file, O_RDWR)) { - redo OPEN if $! == ENOENT; - croak "open $file: $!"; - } - } else { - unless (sysopen($f, $file, O_CREAT|O_EXCL|O_RDWR)) { - redo OPEN if $! == EEXIST; - croak "open >$file: $!"; - } - print STDERR " {$$ " if $debug; # } - $created = 1; - } - last; - } - $locks{$file} = $created || $locks{$file} || 0; - $shared{$file} = $shared; - $pid{$file} = $$; - - $lockHandle{$file} = $f; - - my $flags; - - $flags = $shared ? LOCK_SH : LOCK_EX; - $flags |= LOCK_NB - if $nonblocking; - - local($0) = "$0 - locking $file" if $av0debug && ! $nonblocking; - my $r = flock($f, $flags); - - print STDERR " ($$ " if $debug and $r; - - if ($r) { - # let's check to make sure the file wasn't - # removed on us! - - my $ifile = (stat($file))[1]; - my $ihandle; - eval { $ihandle = (stat($f))[1] }; - croak $@ if $@; - - return 1 if defined $ifile - and defined $ihandle - and $ifile == $ihandle; - - # oh well, try again - flock($f, LOCK_UN); - close($f); - return File::Flock::lock($file); - } - - return 1 if $r; - if ($nonblocking and - (($! == EAGAIN) - or ($! == EACCES) - or ($! == EWOULDBLOCK))) - { - if (! $previous) { - delete $locks{$file}; - delete $lockHandle{$file}; - delete $shared{$file}; - delete $pid{$file}; - } - if ($created) { - # oops, a bad thing just happened. - # We don't want to block, but we made the file. - &background_remove($f, $file); - } - close($f); - return 0; - } - croak "flock $f $flags: $!"; -} - -# -# get a lock on a file and remove it if it's empty. This is to -# remove files that were created just so that they could be locked. -# -# To do this without blocking, defer any files that are locked to the -# the END block. -# -sub background_remove -{ - my ($f, $file) = @_; - - if (flock($f, LOCK_EX|LOCK_NB)) { - unlink($file) - if -s $file == 0; - flock($f, LOCK_UN); - return 1; - } else { - $rm{$file} = 1 - unless exists $rm{$file}; - return 0; - } -} - -sub unlock -{ - my ($file) = @_; - - if (ref $file eq 'File::Flock') { - bless $file, 'UNIVERSAL'; # avoid destructor later - $file = $$file; - } - - croak "no lock on $file" unless exists $locks{$file}; - my $created = $locks{$file}; - my $unlocked = 0; - - - my $size = -s $file; - if ($created && defined($size) && $size == 0) { - if ($shared{$file}) { - $unlocked = - &background_remove($lockHandle{$file}, $file); - } else { - # { - print STDERR " $$} " if $debug; - unlink($file) - or croak "unlink $file: $!"; - } - } - delete $locks{$file}; - delete $pid{$file}; - - my $f = $lockHandle{$file}; - - delete $lockHandle{$file}; - - return 0 unless defined $f; - - print STDERR " $$) " if $debug; - $unlocked or flock($f, LOCK_UN) - or croak "flock $file UN: $!"; - - close($f); - return 1; -} - -sub lock_rename -{ - my ($oldfile, $newfile) = @_; - - if (exists $locks{$newfile}) { - unlock $newfile; - } - delete $locks{$newfile}; - delete $shared{$newfile}; - delete $pid{$newfile}; - delete $lockHandle{$newfile}; - delete $rm{$newfile}; - - $locks{$newfile} = $locks{$oldfile} if exists $locks{$oldfile}; - $shared{$newfile} = $shared{$oldfile} if exists $shared{$oldfile}; - $pid{$newfile} = $pid{$oldfile} if exists $pid{$oldfile}; - $lockHandle{$newfile} = $lockHandle{$oldfile} if exists $lockHandle{$oldfile}; - $rm{$newfile} = $rm{$oldfile} if exists $rm{$oldfile}; - - delete $locks{$oldfile}; - delete $shared{$oldfile}; - delete $pid{$oldfile}; - delete $lockHandle{$oldfile}; - delete $rm{$oldfile}; -} - -# -# Unlock any files that are still locked and remove any files -# that were created just so that they could be locked. -# -END { - my $f; - for $f (keys %locks) { - &unlock($f) - if $pid{$f} == $$; - } - - my %bgrm; - for my $file (keys %rm) { - my $f = new IO::File; - if (sysopen($f, $file, O_RDWR)) { - if (flock($f, LOCK_EX|LOCK_NB)) { - unlink($file) - if -s $file == 0; - flock($f, LOCK_UN); - } else { - $bgrm{$file} = 1; - } - close($f); - } - } - if (%bgrm) { - my $ppid = fork; - croak "cannot fork" unless defined $ppid; - my $pppid = $$; - my $b0 = $0; - $0 = "$b0: waiting for child ($ppid) to fork()"; - unless ($ppid) { - my $pid = fork; - croak "cannot fork" unless defined $pid; - unless ($pid) { - for my $file (keys %bgrm) { - my $f = new IO::File; - if (sysopen($f, $file, O_RDWR)) { - if (flock($f, LOCK_EX)) { - unlink($file) - if -s $file == 0; - flock($f, LOCK_UN); - } - close($f); - } - } - print STDERR " $pppid] $pppid)" if $debug; - } - kill(9, $$); # exit w/o END or anything else - } - waitpid($ppid, 0); - kill(9, $$); # exit w/o END or anything else - } -} - -1; - -__DATA__ - -=head1 NAME - - File::Flock - file locking with flock - -=head1 SYNOPSIS - - use File::Flock; - - lock($filename); - - lock($filename, 'shared'); - - lock($filename, undef, 'nonblocking'); - - lock($filename, 'shared', 'nonblocking'); - - unlock($filename); - - my $lock = new File::Flock '/somefile'; - - lock_rename($oldfilename, $newfilename) - -=head1 DESCRIPTION - -Lock files using the flock() call. If the file to be locked does not -exist, then the file is created. If the file was created then it will -be removed when it is unlocked assuming it's still an empty file. - -Locks can be created by new'ing a B object. Such locks -are automatically removed when the object goes out of scope. The -B method may also be used. - -B is used to tell File::Flock when a file has been -renamed (and thus the internal locking data that is stored based -on the filename should be moved to a new name). B the -new name rather than the original name. - -=head1 LICENSE - -File::Flock may be used/modified/distibuted on the same terms -as perl itself. - -=head1 AUTHOR - -David Muir Sharnoff - - diff --git a/modules/fallback/File/Slurp.pm b/modules/fallback/File/Slurp.pm deleted file mode 100644 index 0aad7ed46..000000000 --- a/modules/fallback/File/Slurp.pm +++ /dev/null @@ -1,742 +0,0 @@ -package File::Slurp; - -use strict; - -use Carp ; -use POSIX qw( :fcntl_h ) ; -use Fcntl qw( :DEFAULT ) ; -use Symbol ; - -my $is_win32 = $^O =~ /win32/i ; - -# Install subs for various constants that aren't set in older perls -# (< 5.005). Fcntl on old perls uses Exporter to define subs without a -# () prototype These can't be overridden with the constant pragma or -# we get a prototype mismatch. Hence this less than aesthetically -# appealing BEGIN block: - -BEGIN { - unless( eval { defined SEEK_SET() } ) { - *SEEK_SET = sub { 0 }; - *SEEK_CUR = sub { 1 }; - *SEEK_END = sub { 2 }; - } - - unless( eval { defined O_BINARY() } ) { - *O_BINARY = sub { 0 }; - *O_RDONLY = sub { 0 }; - *O_WRONLY = sub { 1 }; - } - - unless ( eval { defined O_APPEND() } ) { - - if ( $^O =~ /olaris/ ) { - *O_APPEND = sub { 8 }; - *O_CREAT = sub { 256 }; - *O_EXCL = sub { 1024 }; - } - elsif ( $^O =~ /inux/ ) { - *O_APPEND = sub { 1024 }; - *O_CREAT = sub { 64 }; - *O_EXCL = sub { 128 }; - } - elsif ( $^O =~ /BSD/i ) { - *O_APPEND = sub { 8 }; - *O_CREAT = sub { 512 }; - *O_EXCL = sub { 2048 }; - } - } -} - -# print "OS [$^O]\n" ; - -# print "O_BINARY = ", O_BINARY(), "\n" ; -# print "O_RDONLY = ", O_RDONLY(), "\n" ; -# print "O_WRONLY = ", O_WRONLY(), "\n" ; -# print "O_APPEND = ", O_APPEND(), "\n" ; -# print "O_CREAT ", O_CREAT(), "\n" ; -# print "O_EXCL ", O_EXCL(), "\n" ; - -use base 'Exporter' ; -use vars qw( %EXPORT_TAGS @EXPORT_OK $VERSION @EXPORT ) ; - -%EXPORT_TAGS = ( 'all' => [ - qw( read_file write_file overwrite_file append_file read_dir ) ] ) ; - -@EXPORT = ( @{ $EXPORT_TAGS{'all'} } ); -@EXPORT_OK = qw( slurp ) ; - -$VERSION = '9999.13'; - -*slurp = \&read_file ; - -sub read_file { - - my( $file_name, %args ) = @_ ; - -# set the buffer to either the passed in one or ours and init it to the null -# string - - my $buf ; - my $buf_ref = $args{'buf_ref'} || \$buf ; - ${$buf_ref} = '' ; - - my( $read_fh, $size_left, $blk_size ) ; - -# check if we are reading from a handle (glob ref or IO:: object) - - if ( ref $file_name ) { - -# slurping a handle so use it and don't open anything. -# set the block size so we know it is a handle and read that amount - - $read_fh = $file_name ; - $blk_size = $args{'blk_size'} || 1024 * 1024 ; - $size_left = $blk_size ; - -# DEEP DARK MAGIC. this checks the UNTAINT IO flag of a -# glob/handle. only the DATA handle is untainted (since it is from -# trusted data in the source file). this allows us to test if this is -# the DATA handle and then to do a sysseek to make sure it gets -# slurped correctly. on some systems, the buffered i/o pointer is not -# left at the same place as the fd pointer. this sysseek makes them -# the same so slurping with sysread will work. - - eval{ require B } ; - - if ( $@ ) { - - @_ = ( \%args, <IO->IoFLAGS & 16 ) { - -# set the seek position to the current tell. - - sysseek( $read_fh, tell( $read_fh ), SEEK_SET ) || - croak "sysseek $!" ; - } - } - else { - -# a regular file. set the sysopen mode - - my $mode = O_RDONLY ; - -#printf "RD: BINARY %x MODE %x\n", O_BINARY, $mode ; - -# open the file and handle any error - - $read_fh = gensym ; - unless ( sysopen( $read_fh, $file_name, $mode ) ) { - @_ = ( \%args, "read_file '$file_name' - sysopen: $!"); - goto &_error ; - } - - binmode($read_fh, $args{'binmode'}) if $args{'binmode'}; - -# get the size of the file for use in the read loop - - $size_left = -s $read_fh ; - - unless( $size_left ) { - - $blk_size = $args{'blk_size'} || 1024 * 1024 ; - $size_left = $blk_size ; - } - } - -# infinite read loop. we exit when we are done slurping - - while( 1 ) { - -# do the read and see how much we got - - my $read_cnt = sysread( $read_fh, ${$buf_ref}, - $size_left, length ${$buf_ref} ) ; - - if ( defined $read_cnt ) { - -# good read. see if we hit EOF (nothing left to read) - - last if $read_cnt == 0 ; - -# loop if we are slurping a handle. we don't track $size_left then. - - next if $blk_size ; - -# count down how much we read and loop if we have more to read. - $size_left -= $read_cnt ; - last if $size_left <= 0 ; - next ; - } - -# handle the read error - - @_ = ( \%args, "read_file '$file_name' - sysread: $!"); - goto &_error ; - } - -# fix up cr/lf to be a newline if this is a windows text file - - ${$buf_ref} =~ s/\015\012/\n/g if $is_win32 && !$args{'binmode'} ; - -# this is the 5 returns in a row. each handles one possible -# combination of caller context and requested return type - - my $sep = $/ ; - $sep = '\n\n+' if defined $sep && $sep eq '' ; - -# caller wants to get an array ref of lines - -# this split doesn't work since it tries to use variable length lookbehind -# the m// line works. -# return [ split( m|(?<=$sep)|, ${$buf_ref} ) ] if $args{'array_ref'} ; - return [ length(${$buf_ref}) ? ${$buf_ref} =~ /(.*?$sep|.+)/sg : () ] - if $args{'array_ref'} ; - -# caller wants a list of lines (normal list context) - -# same problem with this split as before. -# return split( m|(?<=$sep)|, ${$buf_ref} ) if wantarray ; - return length(${$buf_ref}) ? ${$buf_ref} =~ /(.*?$sep|.+)/sg : () - if wantarray ; - -# caller wants a scalar ref to the slurped text - - return $buf_ref if $args{'scalar_ref'} ; - -# caller wants a scalar with the slurped text (normal scalar context) - - return ${$buf_ref} if defined wantarray ; - -# caller passed in an i/o buffer by reference (normal void context) - - return ; -} - -sub write_file { - - my $file_name = shift ; - -# get the optional argument hash ref from @_ or an empty hash ref. - - my $args = ( ref $_[0] eq 'HASH' ) ? shift : {} ; - - my( $buf_ref, $write_fh, $no_truncate, $orig_file_name, $data_is_ref ) ; - -# get the buffer ref - it depends on how the data is passed into write_file -# after this if/else $buf_ref will have a scalar ref to the data. - - if ( ref $args->{'buf_ref'} eq 'SCALAR' ) { - -# a scalar ref passed in %args has the data -# note that the data was passed by ref - - $buf_ref = $args->{'buf_ref'} ; - $data_is_ref = 1 ; - } - elsif ( ref $_[0] eq 'SCALAR' ) { - -# the first value in @_ is the scalar ref to the data -# note that the data was passed by ref - - $buf_ref = shift ; - $data_is_ref = 1 ; - } - elsif ( ref $_[0] eq 'ARRAY' ) { - -# the first value in @_ is the array ref to the data so join it. - - ${$buf_ref} = join '', @{$_[0]} ; - } - else { - -# good old @_ has all the data so join it. - - ${$buf_ref} = join '', @_ ; - } - -# see if we were passed a open handle to spew to. - - if ( ref $file_name ) { - -# we have a handle. make sure we don't call truncate on it. - - $write_fh = $file_name ; - $no_truncate = 1 ; - } - else { - -# spew to regular file. - - if ( $args->{'atomic'} ) { - -# in atomic mode, we spew to a temp file so make one and save the original -# file name. - $orig_file_name = $file_name ; - $file_name .= ".$$" ; - } - -# set the mode for the sysopen - - my $mode = O_WRONLY | O_CREAT ; - $mode |= O_APPEND if $args->{'append'} ; - $mode |= O_EXCL if $args->{'no_clobber'} ; - -#printf "WR: BINARY %x MODE %x\n", O_BINARY, $mode ; - -# open the file and handle any error. - - $write_fh = gensym ; - unless ( sysopen( $write_fh, $file_name, $mode ) ) { - @_ = ( $args, "write_file '$file_name' - sysopen: $!"); - goto &_error ; - } - - binmode($write_fh, $args->{'binmode'}) if $args->{'binmode'}; - } - - sysseek( $write_fh, 0, SEEK_END ) if $args->{'append'} ; - - -#print 'WR before data ', unpack( 'H*', ${$buf_ref}), "\n" ; - -# fix up newline to write cr/lf if this is a windows text file - - if ( $is_win32 && !$args->{'binmode'} ) { - -# copy the write data if it was passed by ref so we don't clobber the -# caller's data - $buf_ref = \do{ my $copy = ${$buf_ref}; } if $data_is_ref ; - ${$buf_ref} =~ s/\n/\015\012/g ; - } - -#print 'after data ', unpack( 'H*', ${$buf_ref}), "\n" ; - -# get the size of how much we are writing and init the offset into that buffer - - my $size_left = length( ${$buf_ref} ) ; - my $offset = 0 ; - -# loop until we have no more data left to write - - do { - -# do the write and track how much we just wrote - - my $write_cnt = syswrite( $write_fh, ${$buf_ref}, - $size_left, $offset ) ; - - unless ( defined $write_cnt ) { - -# the write failed - @_ = ( $args, "write_file '$file_name' - syswrite: $!"); - goto &_error ; - } - -# track much left to write and where to write from in the buffer - - $size_left -= $write_cnt ; - $offset += $write_cnt ; - - } while( $size_left > 0 ) ; - -# we truncate regular files in case we overwrite a long file with a shorter file -# so seek to the current position to get it (same as tell()). - - truncate( $write_fh, - sysseek( $write_fh, 0, SEEK_CUR ) ) unless $no_truncate ; - - close( $write_fh ) ; - -# handle the atomic mode - move the temp file to the original filename. - - rename( $file_name, $orig_file_name ) if $args->{'atomic'} ; - - return 1 ; -} - -# this is for backwards compatibility with the previous File::Slurp module. -# write_file always overwrites an existing file - -*overwrite_file = \&write_file ; - -# the current write_file has an append mode so we use that. this -# supports the same API with an optional second argument which is a -# hash ref of options. - -sub append_file { - -# get the optional args hash ref - my $args = $_[1] ; - if ( ref $args eq 'HASH' ) { - -# we were passed an args ref so just mark the append mode - - $args->{append} = 1 ; - } - else { - -# no args hash so insert one with the append mode - - splice( @_, 1, 0, { append => 1 } ) ; - } - -# magic goto the main write_file sub. this overlays the sub without touching -# the stack or @_ - - goto &write_file -} - -# basic wrapper around opendir/readdir - -sub read_dir { - - my ($dir, %args ) = @_; - -# this handle will be destroyed upon return - - local(*DIRH); - -# open the dir and handle any errors - - unless ( opendir( DIRH, $dir ) ) { - - @_ = ( \%args, "read_dir '$dir' - opendir: $!" ) ; - goto &_error ; - } - - my @dir_entries = readdir(DIRH) ; - - @dir_entries = grep( $_ ne "." && $_ ne "..", @dir_entries ) - unless $args{'keep_dot_dot'} ; - - return @dir_entries if wantarray ; - return \@dir_entries ; -} - -# error handling section -# -# all the error handling uses magic goto so the caller will get the -# error message as if from their code and not this module. if we just -# did a call on the error code, the carp/croak would report it from -# this module since the error sub is one level down on the call stack -# from read_file/write_file/read_dir. - - -my %err_func = ( - 'carp' => \&carp, - 'croak' => \&croak, -) ; - -sub _error { - - my( $args, $err_msg ) = @_ ; - -# get the error function to use - - my $func = $err_func{ $args->{'err_mode'} || 'croak' } ; - -# if we didn't find it in our error function hash, they must have set -# it to quiet and we don't do anything. - - return unless $func ; - -# call the carp/croak function - - $func->($err_msg) ; - -# return a hard undef (in list context this will be a single value of -# undef which is not a legal in-band value) - - return undef ; -} - -1; -__END__ - -=head1 NAME - -File::Slurp - Efficient Reading/Writing of Complete Files - -=head1 SYNOPSIS - - use File::Slurp; - - my $text = read_file( 'filename' ) ; - my @lines = read_file( 'filename' ) ; - - write_file( 'filename', @lines ) ; - - use File::Slurp qw( slurp ) ; - - my $text = slurp( 'filename' ) ; - - -=head1 DESCRIPTION - -This module provides subs that allow you to read or write entire files -with one simple call. They are designed to be simple to use, have -flexible ways to pass in or get the file contents and to be very -efficient. There is also a sub to read in all the files in a -directory other than C<.> and C<..> - -These slurp/spew subs work for files, pipes and -sockets, and stdio, pseudo-files, and DATA. - -=head2 B - -This sub reads in an entire file and returns its contents to the -caller. In list context it will return a list of lines (using the -current value of $/ as the separator including support for paragraph -mode when it is set to ''). In scalar context it returns the entire -file as a single scalar. - - my $text = read_file( 'filename' ) ; - my @lines = read_file( 'filename' ) ; - -The first argument to C is the filename and the rest of the -arguments are key/value pairs which are optional and which modify the -behavior of the call. Other than binmode the options all control how -the slurped file is returned to the caller. - -If the first argument is a file handle reference or I/O object (if ref -is true), then that handle is slurped in. This mode is supported so -you slurp handles such as C, C. See the test handle.t -for an example that does C and child process spews data -to the parant which slurps it in. All of the options that control how -the data is returned to the caller still work in this case. - -NOTE: as of version 9999.06, read_file works correctly on the C -handle. It used to need a sysseek workaround but that is now handled -when needed by the module itself. - -You can optionally request that C is exported to your code. This -is an alias for read_file and is meant to be forward compatible with -Perl 6 (which will have slurp() built-in). - -The options are: - -=head3 binmode - -If you set the binmode option, then the file will be slurped in binary -mode. - - my $bin_data = read_file( $bin_file, binmode => ':raw' ) ; - # Or - my $bin_data = read_file( $bin_file, binmode => ':utf8' ) ; - -=head3 array_ref - -If this boolean option is set, the return value (only in scalar -context) will be an array reference which contains the lines of the -slurped file. The following two calls are equivalent: - - my $lines_ref = read_file( $bin_file, array_ref => 1 ) ; - my $lines_ref = [ read_file( $bin_file ) ] ; - -=head3 scalar_ref - -If this boolean option is set, the return value (only in scalar -context) will be an scalar reference to a string which is the contents -of the slurped file. This will usually be faster than returning the -plain scalar. - - my $text_ref = read_file( $bin_file, scalar_ref => 1 ) ; - -=head3 buf_ref - -You can use this option to pass in a scalar reference and the slurped -file contents will be stored in the scalar. This can be used in -conjunction with any of the other options. - - my $text_ref = read_file( $bin_file, buf_ref => \$buffer, - array_ref => 1 ) ; - my @lines = read_file( $bin_file, buf_ref => \$buffer ) ; - -=head3 blk_size - -You can use this option to set the block size used when slurping from an already open handle (like \*STDIN). It defaults to 1MB. - - my $text_ref = read_file( $bin_file, blk_size => 10_000_000, - array_ref => 1 ) ; - -=head3 err_mode - -You can use this option to control how read_file behaves when an error -occurs. This option defaults to 'croak'. You can set it to 'carp' or -to 'quiet to have no error handling. This code wants to carp and then -read abother file if it fails. - - my $text_ref = read_file( $file, err_mode => 'carp' ) ; - unless ( $text_ref ) { - - # read a different file but croak if not found - $text_ref = read_file( $another_file ) ; - } - - # process ${$text_ref} - -=head2 B - -This sub writes out an entire file in one call. - - write_file( 'filename', @data ) ; - -The first argument to C is the filename. The next argument -is an optional hash reference and it contains key/values that can -modify the behavior of C. The rest of the argument list is -the data to be written to the file. - - write_file( 'filename', {append => 1 }, @data ) ; - write_file( 'filename', {binmode => ':raw' }, $buffer ) ; - -As a shortcut if the first data argument is a scalar or array -reference, it is used as the only data to be written to the file. Any -following arguments in @_ are ignored. This is a faster way to pass in -the output to be written to the file and is equivilent to the -C option. These following pairs are equivilent but the pass -by reference call will be faster in most cases (especially with larger -files). - - write_file( 'filename', \$buffer ) ; - write_file( 'filename', $buffer ) ; - - write_file( 'filename', \@lines ) ; - write_file( 'filename', @lines ) ; - -If the first argument is a file handle reference or I/O object (if ref -is true), then that handle is slurped in. This mode is supported so -you spew to handles such as \*STDOUT. See the test handle.t for an -example that does C and child process spews data to the -parant which slurps it in. All of the options that control how the -data is passes into C still work in this case. - -C returns 1 upon successfully writing the file or undef if -it encountered an error. - -The options are: - -=head3 binmode - -If you set the binmode option, then the file will be written in binary -mode. - - write_file( $bin_file, {binmode => ':raw'}, @data ) ; - # Or - write_file( $bin_file, {binmode => ':utf8'}, @data ) ; - -=head3 buf_ref - -You can use this option to pass in a scalar reference which has the -data to be written. If this is set then any data arguments (including -the scalar reference shortcut) in @_ will be ignored. These are -equivilent: - - write_file( $bin_file, { buf_ref => \$buffer } ) ; - write_file( $bin_file, \$buffer ) ; - write_file( $bin_file, $buffer ) ; - -=head3 atomic - -If you set this boolean option, the file will be written to in an -atomic fashion. A temporary file name is created by appending the pid -($$) to the file name argument and that file is spewed to. After the -file is closed it is renamed to the original file name (and rename is -an atomic operation on most OS's). If the program using this were to -crash in the middle of this, then the file with the pid suffix could -be left behind. - -=head3 append - -If you set this boolean option, the data will be written at the end of -the current file. - - write_file( $file, {append => 1}, @data ) ; - -C croaks if it cannot open the file. It returns true if it -succeeded in writing out the file and undef if there was an -error. (Yes, I know if it croaks it can't return anything but that is -for when I add the options to select the error handling mode). - -=head3 no_clobber - -If you set this boolean option, an existing file will not be overwritten. - - write_file( $file, {no_clobber => 1}, @data ) ; - -=head3 err_mode - -You can use this option to control how C behaves when an -error occurs. This option defaults to 'croak'. You can set it to -'carp' or to 'quiet' to have no error handling other than the return -value. If the first call to C fails it will carp and then -write to another file. If the second call to C fails, it -will croak. - - unless ( write_file( $file, { err_mode => 'carp', \$data ) ; - - # write a different file but croak if not found - write_file( $other_file, \$data ) ; - } - -=head2 overwrite_file - -This sub is just a typeglob alias to write_file since write_file -always overwrites an existing file. This sub is supported for -backwards compatibility with the original version of this module. See -write_file for its API and behavior. - -=head2 append_file - -This sub will write its data to the end of the file. It is a wrapper -around write_file and it has the same API so see that for the full -documentation. These calls are equivilent: - - append_file( $file, @data ) ; - write_file( $file, {append => 1}, @data ) ; - -=head2 read_dir - -This sub reads all the file names from directory and returns them to -the caller but C<.> and C<..> are removed by default. - - my @files = read_dir( '/path/to/dir' ) ; - -It croaks if it cannot open the directory. - -In a list context C returns a list of the entries in the -directory. In a scalar context it returns an array reference which has -the entries. - -=head3 keep_dot_dot - -If this boolean option is set, C<.> and C<..> are not removed from the -list of files. - - my @all_files = read_dir( '/path/to/dir', keep_dot_dot => 1 ) ; - -=head2 EXPORT - - read_file write_file overwrite_file append_file read_dir - -=head2 SEE ALSO - -An article on file slurping in extras/slurp_article.pod. There is -also a benchmarking script in extras/slurp_bench.pl. - -=head2 BUGS - -If run under Perl 5.004, slurping from the DATA handle will fail as -that requires B.pm which didn't get into core until 5.005. - -=head1 AUTHOR - -Uri Guttman, Euri@stemsystems.comE - -=cut