8 WebShare File Server

„websharesrv“ ist der Programmname des WebShare File Servers. Das Programm kann auf dem Host laufen, auf welchem die HELIOS Server EtherShare oder PCShare installiert sind und wird durch den HELIOS Service Controller gesteuert (siehe HELIOS Base Handbuch). Es startet einen eigenen Prozess für jeden angemeldeten Benutzer.

Der WebShare File Server bietet verschiedene nützliche Funktionen für die Benutzer- und Dokumentenverwaltung, wie Benachrichtigung per E-Mail bei Benutzeranmeldung am Server oder zusätzliche eigene WebShare Aktionsskripte.

8.1 Benutzer-Konfigurationsdatei

„HELIOSDIR/var/conf/webshare.passwd“ ist die Benutzer-Konfigurationsdatei für den WebShare File Server. Einige Einstellungen, die im Fenster „Meine Benutzereinstellungen“ (siehe Kapitel 6.7 „Meine Benutzereinstellungen“) gemacht wurden, werden in dieser Datei gesichert:

heliosuser::::zs=1,nocp=1,qs=1::: 
martin::::zs=1,nocp=0,qs=0::: 
ws1:md5_dd1c91f5d657b421c339592f:demo::zs=1,nocp=1,qs=0:::
ws2:clr_cleartextpassword:demo::zs=1,nocp=1,qs=1:::

Jede Zeile der Konfigurationsdatei „webshare.passwd“ beginnt mit dem Benutzernamen gefolgt von mehreren, durch Doppelpunkte getrennte Felder. Das erste Feld (Benutzername) und das dritte Feld (Benutzer-ID) sind obligatorisch, die anderen Felder können auch leer bleiben.

Benutzername

Name des virtuellen oder des Host-Benutzers

Kennwort

(unverschlüsselt oder aus dem unverschlüsselten UTF-8-Kennwort generierter MD-5-Hashwert)

Eine Zeichenkette, die mit md5_ beginnt, ist der Hashwert des Kennworts für virtuelle Benutzer. Eine Zeichenkette, die mit clr_ beginnt, ist das unverschlüsselte Kennwort für virtuelle Benutzer. Für Host-Benutzer kann dieses Feld leer bleiben, wenn kein zusätzliches WebShare Kennwort gesetzt wurde und das HELIOS Host-Kennwort benutzt wird. Wir raten Ihnen aber dennoch, ein zusätzliches Kennwort für WebShare zu setzen.

Als Host-Benutzer ausführen

Ein leeres Feld kennzeichnet einen Host-Benutzer. Für virtuelle Benutzer ist hier der Name eines Host-Benutzers eingetragen, dem der virtuelle Benutzer zugeordnet ist.

Ablaufdatum

Im 4. Feld kann ein Datum angegeben sein, nach dessen Ablauf sich ein Benutzer nicht mehr anmelden kann. Das Format ist:
dd-MMM-yyyy-kk-mm

z. B.: 28-Feb-2004-14-21

Das Ablaufdatum wird im Feld Ablaufdatum im Fenster „Benutzer verwalten“ gemäß der durch DateFormat (Kapitel 8.5 „Präferenzen“) festgelegten Syntax eingegeben.

Optionen

(kommasepariert)

"zs" (zipstream)
“nocp” (Benutzer kann Kennwort nicht ändern)
"pt" (Bevorzugter Datentransfer)
"br" (Branding)=<Brandingname>
"po" (Nur URL-Dokumentenvorschau)
"qs" (Quickshare-Benutzer)

Beispiel:: Ist zipstream aktiviert, zeigt dieses Feld „zs=1“, sonst „zs=0“. Ohne Eintrag ist zipstream aktiviert.

Client-Kodierung

(für Uploads/Downloads)

Name der Client-Kodierung, beispielsweise „MacRoman“. Dieses Feld bleibt leer, wenn „OS Default“ festgelegt wurde.

E-Mail-Adresse

Die E-Mail-Adresse muss vollständig angegeben werden, z. B.:
benutzername@meinefirma.com

Kommentare

Vergewissern Sie sich, dass Kommentare keine Sonderzeichen wie beispielsweise einen Doppelpunkt („:“) enthalten. Diese würden durch einen Unterstrich („_“) ersetzt um die Dateikompatibilität von „webshare.passwd“ zu wahren.

8.2 WebShare Benutzereinstellungen

In der Datei „HELIOSDIR/var/run/WebShare_User_Settings/<Benutzername>.settings“ werden die Benutzereinstellungen gespeichert (* = PrintPreview erforderlich):

* Application.session.annotationParameters
Default.preferredView
* Default.iccProfiles.printer
* Default.iccProfiles.monitor
* Default.iccProfiles.simulation
* Default.screen.width
* Default.screen.width.unit
* Default.screen.pixel
FileBrowser.session.showFileComments
FileBrowser.session.galleryIconSize
FileBrowser.session.searchResultView
FileBrowser.session.searchResultGalleryIconSize
FileBrowser.session.showGalleryDetails
* PrintPreview.zoom.originalSize
WSPrintDialog.settings.paperHeightSetting
WSPrintDialog.settings.marginWidthSetting
WSPrintDialog.settings.paperWidthSetting
WSPrintDialog.settings.resolutionValueString
WSPrintDialog.settings.bindingMargin
WSPrintDialog.settings.scaleImages
WSPrintDialog.settings.paperFormatString
WSPrintDialog.settings.unitName
* WSPrintDialog_ProofMode.settings.paperFormatString
* WSPrintDialog_ProofMode.settings.marginWidthSetting
* WSPrintDialog_ProofMode.settings.resolutionValueString
* WSPrintDialog_ProofMode.settings.controlGraphicPosition
* WSPrintDialog_ProofMode.settings.unitName
* WSPrintDialog_ProofMode.settings.bindingMargin
* WSPrintDialog_ProofMode.settings.paperHeightSetting
* WSPrintDialog_ProofMode.settings.scaleImages
* WSPrintDialog_ProofMode.settings.paperWidthSetting
* WSPrintDialog_ProofMode.settings.controlGraphicString
* WSPrintDialog_ProofMode.settings.printProofImageTitle

8.2.1 WSProperties

Mit dem Objekt „WSProperties“ lassen sich Benutzereinstellungen (siehe 8.2 „WebShare Benutzereinstellungen“) oder eigene Einstellungen über JavaScript aus der Datei „additional.js“ (siehe 4.7.9 „Brandings per JavaScript bearbeiten“) auslesen und setzen. Eigene Einstellungen werden zudem in den Benutzereinstellungen gespeichert, so dass diese permanent als Vorgabe dienen. Werden Benutzervorgaben gesichert (siehe Standard-Benutzereinstellungen speichern in 6.7 „Meine Benutzereinstellungen“), werden eigene Einstellungen nicht gespeichert. „WSProperties“ ist ein Singleton, mit dem sich keine anderen Objekte erzeugen lassen. Beachten Sie bitte, dass getProperty und setProperty gegebenenfalls zu einer Lese-/Schreib-Operation auf dem WebShare File Server führen kann. Möchten Sie, dass diese Methoden asynchron ausgeführt werden, müssen Sie mit setCallback eine Callback-Funktion setzen.

getProperty: function (<String> key)

Liefert einen Wert für diesen Key. Ist der Wert null, false, true oder undefined, wird er in ein entsprechendes JavaScript-Objekt konvertiert, andernfalls wird ein String ausgegeben. Existiert diese Property noch nicht, liefert diese Methode den Wert null.

key: Der Name der abzufragenden Property.

setProperty: function (<String> key, <String> value)

Setzt einen String-Property-Wert für den Key. Diese Methode liefert den neuen Wert der Property, gemäß der Abfrage mit der Methode getProperty.

key: Name der zu setzenden Property.
value: Wert, auf den die Property mit dem Key gesetzt werden soll.

setCallback: function (<Function> func)

Setzt eine Funktion, die immer dann aufgerufen wird, wenn sich das XmlHttpRequest-Attribut readyState ändert. Wird eine Callback-Funktion mit dieser Methode gesetzt, wird die Anfrage asynchron ausgeführt. Die Antwort des Servers wird als Objekt im Format JavaScript Object Notation (JSON) gesendet und enthält das Objekt propertyValue, welches den Wert der abgefragten oder gesetzten Property beinhaltet. Verwenden Sie innerhalb der Callback-Methode die JavaScript-Funktionen eval oder JSON.parse zum Parsen der JSON-Antwort.

func: Eine Referenz zu einer Funktion oder eine anonyme Funktion, die ein XmlHttpRequest-Objekt als Argument verwendet.

8.3 WebShare Dienstprogramme

Die Programme „zipstream“ und „unzipstream“ werden zum Komprimieren von Daten beim Herunterladen bzw. Entpacken beim Hochladen verwendet. Sie befinden sich im Verzeichnis „HELIOSDIR/bin“.

Alle übrigen in diesem Abschnitt beschriebenen Programme sind Perl-Skripte, die im Verzeichnis „HELIOSDIR/etc/webshare/“ liegen. In diesen Skripten wird das Kommando „dt“ benutzt. So wird sichergestellt, dass alle Änderungen sowohl auf die Dateien als auch auf die zusätzlichen Ressourcen dieser Dateien angewandt werden. Dadurch wird sichergestellt, dass die spezifischen Anforderungen der HELIOS Volumes erfüllt sind.

Hinweis:: Diese Perl-Skripte lassen sich benutzerspezifisch anpassen, wobei dies niemals direkt im Originalskript erfolgen sollte, da diese bei Updates überschrieben werden können. Kopieren Sie stattdessen das Skript von „HELIOSDIR/etc/webshare“ in das Verzeichnis „HELIOSDIR/var/webshare“.
WebShare sucht immer erst in „var/webshare“ nach Skripten und benutzt das Verzeichnis „etc/webshare“ lediglich als Alternative, falls das Skript in „var/webshare“ nicht verfügbar ist.

8.3.1 zipstream

Dieses Programm erzeugt ein Zip-Archiv an, dem Sie Dateien und Ordner in komprimierter Form hinzufügen können. Die Vorteile von „zipstream“ gegenüber dem Zip-Programm sind: Während der Komprimierung werden keine temporären Dateien angelegt und das Herunterladen von Daten kann unmittelbar beginnen, ohne auf eine Archiverzeugung zu warten. Dateiattribute wie Erstellungsdatum und Mac-Ressourceinformationen werden als MacBinary kodiert, welches dann im komprimierten Zip-Archiv erhalten bleibt. Die für die Datei- und Ordnernamen im Dateisystem verwendete Kodierung ist UTF-8. Die Kodierung, die für Datei- und Ordnernamen im Zip-Archiv verwendet wird, kann je nach Client-System ausgewählt werden, z. B. MacRoman, PC850, ISO8859-1 oder UTF-8.

Durch die Zip64-Unterstützung lassen sich jetzt auch Dateien herunterladen, die größer als 4 GB sind.

Verwendung:

zipstream [Optionen] Datei 
zipstream -h (für Hilfe)

Folgende Optionen werden unterstützt:

-f

Das Zip-Archiv wird anstatt nach „stdout“ in eine Datei geschrieben.

-C

Eingehende Dateien werden aus diesem Verzeichnis gelesen.

-l

Zip-Komprimierungsgrad. Gültige Werte reichen von 1 (höchste Geschwindigkeit) bis 9 (beste Komprimierung). Der Vorgabewert ist 6.

-c

Die für Dateinamen im Zip-Archiv benutzte Kodierung. Die Vorgabe ist UTF8. Um alle verfügbaren Kodierungsmöglichkeiten aufzulisten verwenden Sie uniconv -l (siehe HELIOS Base Handbuch).

„zipstream“ wird mit dieser Option vom WebShare File Server aufgerufen, wenn aus dem Aufklappmenü Download Encoding im Fenster „Meine Benutzereinstellungen“ oder „Benutzer verwalten“ eine Kodierung ausgewählt wurde.

Hinweis:: Als „zipstream“-Kodierung des Servervolumes wird immer UTF-8 angenommen. Volumes, die nicht in UTF-8 kodiert sind, werden nicht unterstützt.

-S

Die geschätzte Größe des Zip-Archivs wird nach „stdout“ ausgegeben (8 byte integer, network byte order).

-s

Die geschätzte Größe des Zip-Archivs wird nach „stdout“ ausgegeben (4 byte integer, network byte order).

-b

Die Ausgabe erfolgt in Blöcken von n kBytes. Der Vorgabewert ist 32 kB.

-n

Es wird kein Zip-Streaming Format verwendet.

„zipstream“ wird mit dieser Option vom WebShare File Server aufgerufen, wenn die Option Zip Streaming Format deaktiviert ist.

-m

Daten- und Ressourcezweig einer Mac Datei werden als MacBinary kodiert.

-p

Die genaue Größe des Zip-Archivs wird berechnet (erzeugt ein temporäres Zip-Archiv).

-t

Dateikommentare werden in MacBinary eingebunden (Option -m muss gleichzeitig auch gesetzt sein).

-r

„.rsrc“-Verzeichnisse werden beibehalten. Standardmäßig werden „.rsrc“-Verzeichnisse nämlich beim Anlegen eines Zip-Archivs übergangen. Wenn -m gesetzt ist, hat diese Option keine Auswirkungen.

-e

Dem Zip-Archiv wird die Datei „DownloadLog.txt“, die Dateizugriffsfehler und, falls -v gesetzt ist, Erklärungen in Wortform beinhaltet, hinzugefügt.

-v

Erklärungen in Wortform werden nach „stderr“ ausgegeben oder, falls -e auch gesetzt ist, in die Datei „DownloadLog.txt“ in das Zip-Archiv geschrieben.

-z

Symbolische Links werden aufgelöst und die Dateien dann dem Zip-Archiv hinzugefügt.

-x

OS X Finder kompatible Zip-Archive werden erstellt, so dass keine zusätzliche Software für Archivierungszwecke benötigt wird.

-i

Gibt den Pfad zu der Download-Logdatei an.

-o

Zu überspringenden <offset> einer Datei angeben. Diese Option gilt nur für Zip-Archive, die eine einzige Datei enthalten, beispielsweise nur Wiederaufnahme von abgebrochenen Downloads.

-N

Gibt den Namen für den Zip-Verzeichniseintrag an.

-d

Gibt die Differenz zur UTC (Universal Time Coordinated) in Sekunden an, die bei der Erzeugung von Daten innerhalb eines Zip-Archivs berücksichtigt wird.

-u

Alle Zip-Archive als Zip64-Archiv anlegen (andernfalls wird bei Archiven, die größer als 2 GB sind, automatisch auf Zip64 gewechselt).

-w

Ignoriert die WebShare Präferenz HideSpecialFiles.

Beispiel:

Legen Sie ein Zip-Archiv namens „archiv.zip“ an und fügen Sie dem Archiv „file1“, „file2“, „dir1“ und „dir2“ hinzu:

$ zipstream -f archive.zip file1 file2 dir1 dir2

8.3.2 unzipstream

Dieses Programm entpackt Zip-Archive und dekodiert MacBinary-Dateien.

Dabei liest es standardmäßig die Zip- oder MacBinary Datei von „stdin“ ein. Mit der Option -f kann dann eine Zip- oder MacBinary-Eingangsdatei ausgewählt werden. Ausgegebene Dateien werden unter den Namen, die in der Zip- oder MacBinary-Datei definiert sind, gesichert. Handelt es sich bei der Eingangsdatei weder um eine Zip- noch um eine MacBinary-Datei, wird sie nach „stdout“ oder in die mit der Option -o festgelegten Datei ausgegeben.

Verwendung:

unzipstream [options] file 
unzipstream -h (for help info)

Folgende Optionen werden unterstützt:

-f

Anstelle von „stdin“ wird aus dem Zip-Archiv gelesen.

-o

Der Dateiname wird angegeben. Diese Option wird nur dann benutzt, wenn die Eingangsdatei weder eine Zip- noch eine MacBinary-Datei ist.

-C

Die Ausgabedateien werden in dieses Verzeichnis geschrieben.

-c

Legt die Kodierung für Dateinamen im Zip-Archiv fest. Der Vorgabewert ist UTF8.

Mit dem Befehl uniconv -l (siehe HELIOS Base Handbuch) können alle verfügbaren Kodierungen aufgelistet werden.

Hinweis:: Als Kodierung für das Servervolume, auf welchem Zip-Dateien entpackt werden, wird immer UTF-8 angenommen. Volumes, die nicht UTF-8 kodiert sind, werden nicht unterstützt.

-r

„.rsrc“-Verzeichnisse bleiben erhalten. Standardmäßig werden Dateien in „.rsrc“-Verzeichnissen nicht aus dem Zip-Archiv entpackt.

Hinweis:: Um eine Übereinstimmung zwischen der Information in der Desktop-Datenbank eines HELIOS Volumes und den auf diesem Volume befindlichen Dateien/Ordnern zu gewährleisten, laden oder entpacken Sie ein Zip-Archiv, das „.rsrc“-Verzeichnisse enthält, nicht direkt auf ein aktives HELIOS Volume. Verwenden Sie zu diesem Zweck besser die „dt“ Tools (siehe HELIOS Base Handbuch).

-n <scriptname>

Diese Option lässt Sie den Namen eines Benachrichtigungsskripts angeben, das immer dann aufgerufen wird wenn eine Datei entpackt wird. Das Skript wird mit den folgenden Parametern aufgerufen:

backupOriginal
replaceOriginal
directory
temporary file name
original file name
file type („Image“ oder „NoImage“)

-m

Gibt den MIME-Typ der Eingangsdatei an. Wird die Option -m gesetzt, so nimmt „unzipstream“ keine Überprüfung des Headers der Eingangsdatei vor um den Dateityp zu ermitteln. Zurzeit werden zwei MIME-Typen unterstützt: application/x-macbinary und application/octet-stream. Wird application/octet-stream angegeben, gibt „unzipstream“ die Eingangsdatei unverändert aus.

-l

Die Dateien werden aufgelistet statt entpackt.

-u

Zeigt „dot“-Dateien an, wobei der Punkt zu Beginn des Namens durch einen Unterstrich ersetzt wird.

Beispiel:: .DS_Store wird als _DS_Store. dargestellt.

-i

Gibt den Pfad zu Upload-Logdatei an.

-x <offset>

Überspringt die <offset> Bytes in der Zieldatei vor dem Entpacken. Diese Option sollte nur in Kombination mit -t und Archiven, die lediglich eine einzelne Datei enthalten, verwendet werden, um einen abgebrochenen Upload fortzusetzen.

-y <fileContentLength>

Gibt die Länge des Inhalts der hochzuladenden Datei an. Dieser geschätzte Wert wird überprüft, um abgebrochene Uploads zu erkennen.

-t

Gibt den temporären Namen der hochzuladenen Datei an. Diese Option wird nur in Kombination mit -x verwendet.

-b

Wenn die zu entpackende Datei bereits existiert, wird eine Sicherungskopie der bereits vorhandenen Datei angelegt. Diese Option wird nur zusammen mit dem Benachrichtigungsskript „wsuploadmv“ genutzt. „wsuploadmv“ legt die Datei standardmäßig unter einem anderen Namen an (z. B. „file dup.txt“), falls diese Datei bereits existiert.

-R

Wenn die zu entpackende Datei bereits existiert, wird sie ersetzt. Diese Option wird nur zusammen mit dem Benachrichtigungsskript „wsuploadmv“ genutzt. „wsuploadmv“ legt die Datei standardmäßig unter einem anderen Namen an (z. B. „file dup.txt“), falls diese Datei bereits existiert.

-g <modtime>

Setzt die Modifikationszeit der entpackten Datei. Diese Option sollte nur mit Archiven, die lediglich eine einzelne Datei enthalten, verwendet werden.

-d

Gibt die Differenz in Sekunden relativ zur koordinierten Weltzeit UTC (Coordinated Universal Time) an.

-v

Erklärungen in Wortform werden nach „stderr“ ausgegeben.

Beachten Sie bitte, dass, wenn eine Zip-Datei ihrerseits weitere Zip-Archive enthält, diese nicht weiter entpackt werden.

Beispiele:

Zeigt die Liste des Zip-Archivs bei angenommener Windows-Kodierung (PC850):

$ unzipstream -l -c PC850 -f archive.zip

Entpackt das Zip-Archiv, das von DropZip angelegt wurde, am Beispiel einer Mac-Kodierung (MacRoman):

$ unzipstream -c MacRoman -f archive.zip

Entpackt alle Dateien aus dem Archiv „abc.zip“ in das Verzeichnis „/data/zips“:

$ unzipstream -f abc.zip -C /data/zips

8.3.3 wscommon.pm

Die Datei „HELIOSDIR/etc/webshare/wscommon.pm“ ist ein Library-Modul in Perl, welches von allen WebShare Perl-Skripten verwendet wird. Es beinhaltet beispielsweise Informationen über weitere installierte HELIOS Produkte.

8.3.4 Umgebungsvariablen für Aktionsskripte

Folgende Umgebungsvariablen stehen WebShare Aktionsskripten und Dienstprogrammen zur Verfügung:

Umgebungsvariable	Beschreibung
WSUserEncoding	Kodierung beim Herunterladen; z. B. OS Default
WSAccept-Language	Standardsprache für die Darstellung von Webseiten; z. B. en
WSWindowsEncoding	Standard Windows-Kodierung; z. B. „PC850“
WSStreamingZip	Zip-Streaming Format; z. B. „Yes“
WSMacintoshEncoding	Standard Mac-OS-Kodierung; z. B. „MacRoman“
WSUserId	Effektive Benutzer-ID der aktuellen Sitzung; z. B. „105“
WSGroupId	Effektive Gruppen-ID der aktuellen Sitzung; z. B. „30“
WSUser	Name des angemeldeten Benutzers
WSUserEMail	E-Mail-Adresse des angemeldeten Benutzers
WSSessionSeq	„websharesrv“-Prozess ID (843) und Anzahl von Logins (64); z. B. „843-64“
WSClientAddress	IP-Adresse des angemeldeten Clients
WSPREVIEWDIR	Verzeichnispfad des WebShare Caches
WSUserAgent	Browserinformation; z. B. „Mozilla/5.0 (Mac; U; PPC Mac OS X Mach-O; en; rv:1.6) Gecko/20040113“
HELIOSDIR	HELIOS Verzeichnispfad; z. B. „/usr/local/helios“

Hinweis:: Folgende Umgebungsvariablen sind nur dann verfügbar, wenn das Skript aus einem Sharepoint über das Menü Aktionen > aufgerufen wird:

Umgebungsvariable	Beschreibung
WSSharepoint	z. B. „Sample Images“
WSSharepath	z. B. „/template-images%0/“

8.3.5 wscopy.pl

Verwendung:

wscopy.pl destdir srcdir files...

Dieses Programm wird vom WebShare File Server aufgerufen, wenn in der Menüleiste die Funktion Kopieren oder Einfügen (Menü Bearbeiten >) ausgewählt wird. „destdir“ gibt das Zielverzeichnis, in das die ausgewählten Dateien und Ordner von „srcdir“ aus kopiert werden, an.

8.3.6 wsmove.pl

Verwendung:

wsmove.pl destdir srcdir files...

Dieses Programm wird vom WebShare File Server aufgerufen, wenn in der Menüleiste die Funktion Verschieben (Menü Bearbeiten >) ausgewählt wird. „destdir“ gibt das Zielverzeichnis, in das die ausgewählten Dateien und Ordner von „srcdir“ aus verschoben werden, an.

8.3.7 wsdownload.pl

Verwendung:

wsdownload.pl zipstream-options offset srcdir files...

Dieses Programm wird vom WebShare File Server aufgerufen, wenn in der Menüleiste die Funktion Download ausgewählt wird. „wsdownload.pl“ verwendet das WebShare Dienstprogramm „zipstream“, um ein während der Übertragung erzeugtes Zip-Archiv ohne temporäre Dateien nach „stdout“ zu leiten. Mit dem Argument „zipstream-options“ lassen sich zusätzliche Optionen in einen „zipstream“ Programmaufruf weiterleiten. „offset“ definiert die Anzahl der Bytes, die bei der Wiederaufnahme von Downloads von Archiven, die nur eine einzige Datei enthalten, übersprungen werden. Das Verzeichnis „srcdir“ gibt das aktuelle Verzeichnis der Web-Sitzung des Benutzers an. Das Argument „files“ repräsentiert die Dateien und Ordner, die vom Benutzer zum Herunterladen markiert worden sind. „wsdownload“ verwendet das WebShare Dientprogramm „zipstream“ um ein während der Übertragung erstelltes Zip-Archiv ohne temporäre Dateien nach „stdout“ zu leiten. Einstellungen wie z. B. Zip-Format, Kodierung des Dateinamens, Unterstützung für MacBinary oder Client-Plattform (Mac oder Windows) werden automatisch durch das Skript „wsdownload“ festgelegt.

8.3.8 wsdup.pl

Verwendung:

wsdup.pl dir files...

Dieses Programm wird vom WebShare File Server aufgerufen, wenn in der Menüleiste die Funktion Duplizieren (Menü Datei >) ausgewählt wird.

8.3.9 wsmkdir.pl

Verwendung:

wsmkdir.pl dir newdir

Dieses Programm wird vom WebShare File Server aufgerufen, wenn in der Menüleiste die Funktion Verzeichnis anlegen (Menü Datei >) ausgewählt wird.

8.3.10 wsmv.pl

Verwendung:

wsmv.pl dir source dest

Dieses Programm wird vom WebShare File Server aufgerufen, wenn in der Menüleiste die Funktion Umbenennen (Menü File >) ausgewählt wird.

8.3.11 wspreview.pl

Verwendung:

wspreview.pl srcfile srcfiletype dstfiletype previewfile resOptions
page antialiasPDF

Dieses Programm wird vom WebShare File Server aufgerufen, wenn eine Bild- oder Dokumentenvorschau angefordert wird, die Vorschaudatei sich aber nicht im Cache befindet (oder veraltet ist).

Parameter:

srcfile: Der vollständige Pfadname der Bild- oder Dokumentendatei, die der Benutzer zur Voransicht ausgewählt hat.
srcfiletype: Dateiformat des Dokuments, von dem eine Voransicht erzeugt werden soll.
dstfiletype: Der Dateityp des Vorschaubildes, üblicherweise JPEG oder PNG. Details finden Sie in Kapitel „Erzeugte Vorschaudateien“.
previewfile: Der Pfad des Dateinamens der Voransicht. Der Dateiname legt den Namen, unter dem die Voransicht im Cache gesichert wird, fest.
resOptions: Dieser Parameter legt die Voransichtsoptionen für den Befehl „layout“ fest. Mehrere Parameter werden durch eine vertikale Linie („|“) getrennt. Ein Beispiel:
-oxpix=256|-orotate=90|-oflipvertical
page: Die Seitennummer, mit 1 beginnend, wird für mehrseitige Dokumente benutzt.
antialiasPDF: Mit „True“ oder „False“ bestimmen Sie, ob Antialiasing für PDF-Eingangsdateien verwendet wird.

8.3.12 wsforgotpw.pl

Hinweis:: Dieses Skript kann auch ohne Benutzeranmeldung aufgerufen werden.

Verwendung:

wsforgotpw.pl opts...

Dieses Skript wird vom WebShare File Server aufgerufen, wenn Kennwort vergessen? auf der Startseite geklickt wird. Die folgende Tabelle führt die Perl-Skript Variablen in der linken Spalte, und in der rechten die entsprechenden HTML Felder der Datei „ForgotPassword.wod“ (siehe 7.3.2 „„*.wod“-Dateien anpassen“). Beachten Sie bitte, dass die Namen der Perl-Skript-Variablen feststehen und nicht umbenannt werden dürfen! Falls Felder nicht benötigt werden, können sie leer gelassen werden:

wsforgotpw.pl	ForgotPassword.wod
$username	editUser.username
$email	editUser.email
$organization	editUser.organization
$comment	editUser.comment
$field5 … $field10	editUser.field5 … 10

8.3.13 wsregnewuser.pl

Hinweis:: Dieses Skript kann auch ohne Benutzeranmeldung aufgerufen werden.

Verwendung:

wsregnewuser.pl opts...

Dieses Skript wird vom WebShare File Server aufgerufen, wenn Als neuer Benutzer registrieren auf der Startseite geklickt wird. Die folgende Tabelle führt die Perl-Skript Variablen in der linken Spalte, und in der rechten die entsprechenden HTML Felder der Datei “RegisterNewUser.wod“ (siehe 7.3.2 „„*.wod“-Dateien anpassen“). Beachten Sie bitte, dass die Namen der Perl-Skript-Variablen feststehen und nicht umbenannt werden dürfen! Falls Felder nicht benötigt werden, können sie leer gelassen werden:

wsregnewuser.pl	RegisterNewUser.wod
$username	editUser.username
$password	editUser.password
$verifyPassword	editUser.verifyPassword
$email	editUser.email
$comment	editUser.comment
$organization	editUser.organization
$field7 … $field20	editUser.field7 … 20

8.3.14 wsrm.pl

Verwendung:

wsrm.pl dir files...

Dieses Programm wird vom WebShare File Server aufgerufen, wenn in der Menüleiste die Funktion Löschen (Menü Datei >) ausgewählt wird.

8.3.15 wsperm.pl

Verwendung:

wsperm.pl dir user group userMode groupMode otherMode recursive files

Dieses Programm wird vom WebShare File Server aufgerufen, wenn in der Menüleiste die Funktion Zugriffsrechte (Menü Datei >) ausgewählt wird.

8.3.16 wsupload.pl

Verwendung:

wsupload.pl dstdir filesize backupOriginal replaceOriginal fileOffset
tmpFilename filename mimetype

Dieses Programm wird vom WebShare File Server aufgerufen, wenn in der Menüleiste die Funktion Upload (Menü Transfer >) ausgewählt wird. „wsupload“ erhält den Datenstrom von „stdin“ und entpackt ihn in das durch den Parameter „dstdir“ festgelegte Verzeichnis. Das Dienstprogramm „unzipstream“ wird im Hintergrund zum Entpacken des Datenstroms während der Übertragung benutzt. Sobald eine Datei im Zip-Datenstrom entdeckt wird, wird sie unter einem temporären Namen mit der Prozess-ID als Suffix gesichert. Das Skript „wsuploadmv“ wird für jede einzelne Datei im Zip-Datenstrom aufgerufen, um die Datei mit dem Suffix der Prozess-ID in ihren endgültigen Namen umzubenennen. All dies geschieht während der Übertragung, während „unzipstream“ mit dem Empfang von weiteren Dateien innerhalb des Zip-Datenstroms fortfährt. „wsupload“ findet automatisch heraus, ob das Hochladen von Daten von einem Windows oder einem Mac-Client geschieht und wählt so eine geeignete Zeichensatzkodierung gemäß der Benutzer- sowie Systemvorgaben.

8.3.17 wsuploadmv.pl

Verwendung:

wsuploadmv.pl backupOriginal replaceOriginal dir source dest
              backupOriginal and replaceOriginal can be set
              to '1' or '0'

Dieses Programm benennt hochgeladene Dateien von ihrem temporären Namen in ihren endgültigen Namen um. „wsuploadmv“ eignet sich hervorragend zur Integration anderer Aufgaben und Abläufe, z. B. einer Anti-Virus-Software, die hochgeladene Dateien prüft.

8.3.18 Serviceport des WebShare File Servers

Dieser Dienst zeigt Benutzer- und Statusinformationen des WebShare File Servers an.

Nachdem Sie socket localhost auf der Kommandozeile mit einer geeigneten Portnummer aufgerufen haben, können Sie zusätzliche Befehle wie users, status oder help eingeben um sich mögliche Optionen anzeigen zu lassen:

$ socket localhost 2016 
Welcome to the HELIOS WebShare File Server service port 

help

help - print a list of available commands 
quit - close connection 
status - show status information 
users - show user information 
rmcache - remove all cache files

users

# PID      User UID Address       CRC       Login 
1 inactive tom  101 192.168.1.2   24c9ce    Mon 10:38 
1 active   joe  108 192.168.1.8   3bffc9d6  Thu 11:23 
Summary: 1 active users (1 inactive users)

status

WebShare File Server, Version 4.0.0u1107 
Up since: Wed Dec 3 10:25:30 2014 
Max users: 0 
Max users allowed: 65535

Hinweis:: Aus Sicherheitsgründen akzeptiert der Serviceport des WebShare File Servers ausschließlich eingehende Verbindungen von localhost. Der Remote-Zugriff ist nicht erlaubt.

8.4 WebShare Skripte

8.4.1 Benutzerdefinierte Skripte

Es ist ohne Weiteres möglich, Skripte in den WebShare Arbeitsablauf zu integrieren, die z. B. Aufgaben automatisieren. WebShare wird mit Beispielskripten ausgeliefert („wslogin.pl“, „wsaddshare.pl“, „wslogout.pl“, „wsmail“ und „wspreviewaccess“), welche – sollen sie etwas bewirken – erst vom Benutzer angepasst werden müssen, und Aktionsskripten (siehe Kapitel 8.4.3 „Aktionsskript: Beispiele“). Benutzerdefinierte Skripte werden im Verzeichnis „HELIOSDIR/etc/webshare/samples“ gespeichert. Zusätzlich können die WebShare Skripte in „HELIOSDIR/etc/webshare“, die in Kapitel 8.3 „WebShare Dienstprogramme“ beschrieben wurden, angepasst werden.

Hinweis:: Die Ausgabegröße von eigenen Skripten ist standardmäßig auf 64 kB begrenzt. Die Fehlerausgabe ist jedoch auf 2 kB begrenzt.

Die im Folgenden beschriebenen Skripte werden erst dann aktiv, wenn sie nach „var/webshare“ kopiert worden sind.

wslogin.pl

Dieses Skript wird nach einer erfolgreichen Anmeldung am WebShare Server mit folgenden Parametern aufgerufen:

Benutzername
Scheinbare Benutzer-IP-Adresse (befindet sich der Benutzer z. B. „hinter“ einem Proxy-Server, wird die IP-Adresse des Proxys als IP-Adresse des Benutzers angenommen)
Vollständige Browseridentifikation (User Agent)
Zeichenkette mit der Benutzer-ID
Options-Zeichenkette mit dem Benutzertyp (Virtueller oder Host-Benutzer) als ersten Eintrag; der Eintrag „IsAdmin“ erscheint, durch Komma getrennt, wenn der Benutzer administrative Rechte besitzt

Das Skript kann so angepasst werden, dass es bei einer Benutzeranmeldung jede gewünschte Aktion ausführt. Ein Ausgabewert von 0 erlaubt die Benutzeranmeldung, während ein anderer Wert als 0 die Anmeldung verbietet. Gleichzeitig kann über „stderr“ eine Fehlermeldung ausgegeben werden.

Erweiterte Sicherheit bei Anmeldungen von Document Hub

Dieses Skript lässt sich auch für eine erweiterte Sicherheitsstufe bei der Anmeldung von Document Hub verwenden. Dazu wird eine Liste der IDs mobiler Geräte definiert, welche sich am WebShare Webserver anmelden dürfen. Ein WebShare-Beispielskript „wslogin.pl“, das diese Document-Hub-IDs verwendet, kann vom HELIOS WebShare-Server heruntergeladen werden:

	Server:	webshare.helios.de
	Benutzername:	tools
	Kennwort:	tools
	Sharepoint:	HELIOS Tools
	Auswahl:	HELIOS WebShare > Sample wslogin.pl for DocumentHub IDs

wsaddshare.pl

Jedesmal wenn ein WebShare Administrator einen Sharepoint neu anlegt oder Änderungen an einem bestehenden vornimmt, wird das Skript „wsaddshare.pl“ aufgerufen. Folgende Parameter stehen dafür zur Verfügung:

Name des Sharepoints
Pfad des Sharepoints
E-Mail-Adresse für den Sharepoint
Options-Zeichenkette mit den Boolschen Präferenzen des Sharepoints (Publish, AllowDownload usw.), der die Sharepoint-Präferenzen in einer durch Komma getrennten Liste enthält
Liste aller Benutzer, die den Sharepoint sehen dürfen
Liste aller Gruppen, deren Mitglieder den Sharepoint sehen dürfen

Durch Anpassung dieses Skripts kann ein Systemadministrator verhindern, dass ein WebShare Administrator einen Sharepoint anlegt, dessen Pfad jenseits des für ihn erlaubten Bereichs liegt. Der Ausgabewert von 0 erlaubt das Anlegen eines Sharepoints sowie Änderungen an diesem, während ein anderer Wert als 0 derlei Aktionen verbietet. Gleichzeitig kann über „stderr“ eine Meldung an den Systemadministrator ausgegeben werden.

wslogout.pl

Sobald sich ein Benutzer vom WebShare Server abgemeldet hat, wird dieses Skript mit den folgenden Parametern aufgerufen:

Benutzername
TCP/IP-Adresse des HTTP-Clients
Vollständige Browseridentifikation (User Agent)

Dieses Skript könnte z. B. so angepasst werden, dass Verzeichnisse aufgeräumt oder ähnliche Aufgaben erledigt werden. Im Gegensatz zu wslogin.pl und wsaddshare.pl wird der Ausgabewert dieses Skripts nicht interpretiert.

wsemail.pl

Dieses Aktionsskript wird immer dann aufgerufen, wenn ein Benutzer eine E-Mail über WebShare verschickt. Das Skript wird mit folgenden Parametern aufgerufen:

Benutzername
Empfänger (Feld An:)
Kopie der Mail an (Feld Cc:)
Blindkopie der Mail an (Feld Bcc:)
Betreff
Mailtext

Das Skript muss mit Status 0 beenden, damit der Benutzer eine E-Mail verschicken kann oder mit Status 1 um dies nicht zuzulassen.

wspreviewaccess.pl

Wird ein Skript mit dem Namen „wspreviewaccess.pl“ in das Verzeichnis „HELIOSDIR/var/webshare“ kopiert, wird es jedes Mal dann aufgerufen, wenn eine Bildvorschau angefordert wird.

Das Skript wird mit zwei Argumenten aufgerufen:

1. <Pfadname> zum Bild
2. <Pfadname> zum Vorschau-Cache

Dadurch wird Skripten von Drittanbietern, die diese Information nutzen könnten um über Vorschau-Aktivitäten benachrichtigt zu werden, ein exaktes Logging ermöglicht.

8.4.2 Fehlerbehebung in WebShare Skripten

Alle WebShare Skripte inklusive der Beispielskripte sind in Perl geschrieben worden. Sie können aber auch in jeder anderen Sprache wie z. B. Shell, PHP, Perl, Java, C/C++ geschrieben werden. HELIOS bevorzugt Perl, da es sehr leistungsfähig und zu vielen verschiedenen Plattformen kompatibel ist. Dieser Abschnitt stellt eine Anleitung für die Fehlerbehebung in Perl Skripten vor, die als Werkzeug und Aktionsskript in WebShare benutzt werden können. Achten Sie darauf Ihr Skript so aufzusetzen, dass es grundsätzlich funktioniert, bevor Sie an ihm eine Fehlerbehebung in der WebShare Umgebung vornehmen.

Umgebungsvoraussetzungen:
Alle Skripte werden mit dem Arbeitsverzeichnis HELIOSDIR, welches standardmäßig „/usr/local/helios“ ist, aufgerufen. Um unabhängig vom Perl Installationspfad zu allen Plattformen kompatibel zu sein, findet sich bei allen WebShare Perl-Skripten die Zeichenkette #!var/run/runperl in der ersten Zeile. „runperl“ ist ein symbolischer Link zum lokalen Perl-Interpreter. Der „runperl“-Link wird während der Installation von WebShare automatisch angelegt. Alle WebShare Vorgabeskripte befinden sich in „etc/webshare“. Eigene Skripte sollten in „var/webshare“ gespeichert werden, damit ein Überschreiben der Skripte während einer Neuinstallation der Software vermieden wird. Ein weiterer Vorteil ist, dass der Ordner „var“ alle Benutzeranpassungen und -einstellungen enthält, was eine einfache und schnelle Migration auf andere Serverplattformen gewährleistet, da die Änderungen nicht erneut durchgeführt werden müssen.

Fehlerinformationen ausgeben:
Da viele Skripte ihre Ergebnisse nach „stdout“ oder „stderr“ ausgeben, führt die Ausgabe von Skriptvariablen zu einer schlecht lesbaren Ausgabe. was wiederum zu Fehlfunktionen führt. Alle HELIOS Skripte unterstützen daher die Ausgabe in eine Datei, wenn die Umgebungsvariable „DEBUGTTY“ gesetzt wird.

Einfache Fehlerbehebung:

# cd /usr/local/helios 
# export DEBUGTTY=/dev/tty 
# var/webshare/actions/<yourscriptname>

Mit den oben aufgeführten Befehlen können Sie das Skript testweise durchlaufen lassen und das Ergebnis überprüfen.

Fehlerbehebung bei einem laufenden WebShare File Server:

# cd /usr/local/helios 
# bin/srvutil stop websharesrv # to stop the webshare file server 
# export DEBUGTTY=/dev/tty 
# sbin/websharesrv

Wird der WebShare File Server, wie hier gezeigt, manuell gestartet, erfolgt die gesamte Ausgabe in das aktuelle Terminal.

8.4.3 Aktionsskript: Beispiele

Wie schon in Kapitel 8.4.1 „Benutzerdefinierte Skripte“ erwähnt, wird WebShare mit diversen Aktionsskripten ausgeliefert:

wsannotations.pl (List annotations)
wscmdargs.pl (Cmd ARGS)
wsdialog.pl (Dialog sample)
wsdu.pl (Disk usage)
wsimageinfo.pl (Image info)
wslinks.pl (WebShare link example)
wsll.pl (ls -l)
wspdfinfo.pl (PDF info)
wssendmsg.pl (Send message)
wsspotlightmeta.pl (Spotlight metadata)
wsxpvcollect.pl (Collect files from XPV)
wsxpvinfo.pl (XPV info)

Im Menü wird der Titel verwendet, der im Skript-Header in der Zeile #Title= eingetragen ist.

Die Skripte werden bei der Installation unter „var/settings/WebShare/Actions/Samples“ abgelegt, müssen jedoch nach „var/settings/WebShare/Actions“ kopiert werden, damit sie im Aufklappmenü Aktionen > in der Menüleiste des Sharepoints (siehe Aktionen > in Kapitel 6.3 „In einem Sharepoint arbeiten“) verfügbar sind. Darüber hinaus regeln die Dateizugriffsrechte eines jeden Aktionsskripts, ob dieses für den einzelnen Benutzer überhaupt sichtbar ist. Siehe auch Kapitel 10.1.7 „Aktionsskripte“.

wsannotations.pl

Dieses Skript gibt eine Tabelle aller Anmerkungen des aktuellen Sharepoints aus und bietet eine Suchfunktion für Anmerkungen.

wscmdargs.pl

Dieses Aktionsskript gibt alle Argumente sowie die Umgebungsvariablen des Skripts aus.

wsdialog.pl

Dieses zweistufige Aktionsskript generiert zuerst ein Formular mit eigenen HTML-Feldern (Textfelder, Schaltflächen usw.) und verarbeitet diese anschließend.

wsdu.pl

Dieses Aktionsskript zeigt die Plattenplatzbelegung der ausgewählten Dateien mithilfe des Befehls du an.

wsimageinfo.pl

(ImageServer erforderlich) Aktionsskript zum Abrufen von Informationen über ein Bild.

wslinks.pl

Über dieses Aktionsskript lassen sich die WebShare-Komponenten file browser, preview, proof, download, Spotlight search, upload öffnen, um HTML-Links dynamisch zu erzeugen, die es dem Anwender ermöglichen, in verschiedene WebShare-Komponenten zu navigieren, z. B. in die Proofansicht von Seite 12 einer bestimmten Datei mit einer Größe von 100%.

wsll.pl

Dieses Aktionsskript listet den Inhalt des aktuellen Verzeichnisses mithilfe des Kommandos ls -l (unter Windows mit dem Befehl dir) auf.

wspdfinfo.pl

(PDF HandShake erforderlich) Aktionsskript zum Abrufen von Informationen über ein PDF-Dokument.

wssendmsg.pl

Dieses Aktionsskript sendet Benachrichtigungen direkt aus WebShare an alle Benutzer, die über „afpsrv“, „pcshare“ oder „heladmsrv“ angemeldet sind.

wsspotlightmeta.pl

Aktionsskript welches die Spotlight-Metadaten für selektierte Dateien tabellarisch darstellt.

wsxpvcollect.pl

(ImageServer erforderlich) Aktionsskript zum Sammeln der referenzierten Daten (QuarkXPress oder InDesign Dokument oder Bilder) aus dem XPV-Dokument. Zusätzlich wird eine Liste der verwendeten Schriften erstellt.

wsxpvinfo.pl

(ImageServer erforderlich) Aktionsskript zum Abrufen von Informationen über ein XPV-Dokument.

Hinweis:: Beginnt der Name einer Skriptdatei mit „hide-“ (z. B. „hide-scriptname.pl“), wird das Skript nicht im Werkzeugleistenmenü Aktionen > aufgeführt. Das bietet sich für Aktionen an, die von JavaScript gestartet werden (siehe 8.4.4 „Aktionsskripte mit JavaScript starten“), die aber für den Anwender nicht sichtbar sein sollen.

8.4.4 Aktionsskripte mit JavaScript starten

Es ist möglich, ein beliebiges eigenes Skript aus der JavaScript-Datei „additional.js“ zu starten (siehe 4.7.9 „Brandings per JavaScript bearbeiten“). Dadurch können eigene Workflows definiert oder neue Funktionen oder Optionen hinzugefügt werden. Um ein eigenes Aktionsskript über JavaScript zu starten, müssen Sie das Objekt WSJavaScriptCommand verwenden. Eigene Aktionen können von WebShare „Home“, dem WebShare Dateibrowser, der Vorschauseite, dem Proof-Fenster und den Seiten „Administration“ sowie „Meine Benutzereinstellungen“ gestartet werden.

Um eigene Aktionsskripte aus JavaScript zu starten, verwenden Sie das Objekt WSJavaScriptCommand. Dieses enthält folgende öffentlich zugängliche Methoden:

addFiles: Funktion (<Array> oder <Objekt> files)

Fügt einem Aktionsskript Dateien hinzu, so als würden diese im Dateibrowser ausgewählt.

files: Ein Array von HTML-Elementobjekten oder ein einzelnes HTML-Elementobjekt wie HTMLTableRowElement oder HTMLTableCellElement

addParameters: Funktion (<Objekt> parameters)

Übergibt Key/Value-Paare des Objekts als „POST“-Variablen an das Aktionsskript. Wurde dem Namensfeld ein beliebiger Inhalt mittels der Methode setNamefieldContent zugeordnet, liefert diese Methode eine WSJavaScriptCommandException.

parameters: Ein Objekt, welches Key/Value-Paare enthält.

send: Funktion ()

Sendet eine Anfrage. Wurde kein Skriptname über die Methode setCommand gesetzt, liefert diese Methode eine WSJavaScriptCommandException.

Gibt true aus, wenn die Anfrage gesendet wurde und false, wenn keine Anfrage von der aktuellen Komponente gesendet werden kann.

setCallback: Funktion (<Funktion> func)

Ruft das Funktionsobjekt func immer dann auf, wenn sich das Attribut readyState des Objekts XmlHttpRequest verändert. Das Objekt XmlHttpRequest wird dann als Parameter an die Funktion weitergeleitet.

func: Ein Verweis auf das Funktionsobjekt oder eine anonyme Funktion, die ein Objekt XmlHttpRequest als Argument annimmt.

setCommand: Funktion (<String> name)

Setzt den Namen des zu verarbeitenden Skripts.

name: Der Name des zu verarbeitenden Aktionsskripts, z. B. „wsannotations.pl“.

setNamefieldContent: Funktion (<String> content)

Setzt den Inhalt eines Namensfeldes einer Aktion. Wurden beliebige „POST“-Parameter über die Methode addParameters gesetzt, liefert diese Methode eine WSJavaScriptCommandException.

content: Der Inhalt eines Namensfeldes einer Aktionsskripts.

setSharepoint: Funktion (<String> name)

Setzt den Namen des aktuellen WebShare Sharepoints. In den Komponenten FileBrowser, Preview und Proof lässt sich der Name des Sharepoints nicht überschreiben, so dass diese Methode eine WSJavaScriptCommandException liefert, wenn die Methode aufgerufen wird. Diese Methode sollte verwendet werden um in Komponenten, die, wie die Komponente „Administration“, keinen Sharepoint-Kontext haben, einen Sharepoint anzugeben. Sie sollten diese Methode aus einem Try/Catch-Block aufrufen.

name: Der Name eines WebShare Sharepoints.

8.5 Präferenzen

Hinweis:: Dieses Kapitel wurde nicht übersetzt, um die Eindeutigkeit der Beschreibung zu bewahren.

This section lists all the preference keys that are pertinent to the WebShare File Server. Find a description of how to set, view, change or delete preferences, with the HELIOS “prefdump”, “prefvalue”, and “prefrestore” utility programs in “HELIOS utility programs” in the HELIOS Base manual.

Wichtig:: Make sure that preference keys DO NOT start or end with a slash (“/”) character, and note that they are case-sensitive! Also, if any preference key or preference value includes spaces, that key or value must be enclosed in quotes.

: Key: Programs/websharesrv/<preference>

8.5.1 WebShare File Server Präferenzen

WrongAuthDelay: int
2; Specifies the time delay in seconds between failed login requests. This helps increase the security against unauthorized logins, e.g. by password robots, which try to match the password by issuing a large number of passwords per second.
AllowForgotPassword: bool
FALSE; Determines whether the Forgot Password? link becomes visible in the login window. The setting of this preference reflects the state of the Enable Forgot Password Option checkbox on the “Server Preferences” page (Abb. 4.3).
AllowRegisterUser: bool
FALSE; Determines whether the Register as a New User link becomes visible in the login window. The setting of this preference reflects the state of the Enable Register User Option checkbox on the “Server Preferences” page (Abb. 4.3).
AllowEMailMessages: bool
TRUE; Determines whether the Mail function (in the Edit > toolbar menu) is available. The settings of this preference reflects the setting of the Enable E-Mail message for Users checkbox on the “Server Preferences” page (Abb. 4.3).
EnforceCryptedLogin: bool
FALSE; With this preference set to TRUE, only encrypted user logins are permitted (JavaScript must be active in the web browser). The setting of this preference reflects the state of the Enforce RSA Crypted Passwords checkbox in the “Server Preferences” page (Abb. 4.3).
AllowLinkShares: bool
FALSE; With this preference set to TRUE, WebShare allows direct URL access from remote clients.
AllowQuickshares: bool
FALSE; Set this preference to TRUE to allow Quickshares. The setting reflects that of the Allow Quickshares checkbox in the “Server Preferences” page (Abb. 4.3).
GlobalQuickshareUsers: bool
FALSE; With this preference set to TRUE, all Quickshare users are available in the Quickshare User pop-up menu. The setting reflects that of the Quickshare Users Are Global checkbox in the “Server Preferences” page (Abb. 4.3).
QuickshareEmptyPassword: bool
FALSE; With this preference set to TRUE, a remote user is allowed to open Quickshare links by just clicking on them, without the need to previously log in on the WebShare server (requires an empty password). The setting of this preference reflects the state of the Skip Login With Empty Quickshare Passwords checkbox in the “Server Preferences” page (Abb. 4.3).

The following keys require a new login to take effect:

AnnotationPrefix

str

If an annotation is added to a file in the preview or proof window, it is named “<file name>.annotation” and saved adjacent to the original file. This preference allows specifying prefixes for the annotation file, e.g. a dot (“.”), which would hide the file in the WebShare file browser. Also directories can be specified; if “anno/” is specified, the annotation file is saved to the directory “anno” which is created adjacent to the original file.

DisableUTCDelta

bool

FALSE

Allows deactivating the time adjustments. The default is FALSE which means time zones are automatically adjusted.

MaxWoaBlockSize

int

128

This value is specified in kilobytes. The WebShare protocol block size between the WebShare Web Server and the WebShare File Server specifies the maximum size of a command (except for downloads, uploads, and previews, which are streamed). For example, if annotations become larger than 128 kB, this parameter allows increasing the maximum block size to a higher value.

URLSuffixSize

int

For QuickShare tiny URLs this parameter describes how many random bytes are used in the URL to avoid that anonymous users can try out QuickShare URLs by entering all combinations. The default is 8, with a minimum of 2 and a maximum of 254.

logdenied

bool

FALSE

If set to TRUE, this parameter lets “websharesrv” append a record to the system messages if, due to the IP access list, access to one or more users has been denied.

MaxGalleryRes

int

384

This preference specifies the maximum resolution for image previews in the gallery view. If the value of the preference is set to 0, the gallery view mode is not available (the corresponding button in the File > Set View > Gallery menu is grayed out or hidden, depending on the Show Disabled Buttons setting of the used branding, see Menüleiste in 4.7.1 „Brandings erstellen und bearbeiten“).

If the specified value is less than 32 the WebShare Webserver assumes 32 as the maximum size.

TcpRecvSize

int

65536 (64 x 1024)

Specifies the maximum number of TCP data bytes that are passed from the clients to “websharesrv” over the network during a transaction. The number of bytes may need to be limited if the buffer size in the UNIX server is too small. TcpRecvSize can be varied to optimize the data transfer rate.

TcpSendSize

int

65536 (64 x 1024)

Specifies the maximum number of TCP data bytes that are passed from “websharesrv” to the clients over the network during a transaction. The number of bytes may need to be limited if the buffer size in the UNIX server is too small. TcpSendSize can be varied to optimize the data transfer rate.

Hinweis:: Changed values in TcpRecvSize and TcpSendSize will automatically be assigned to the WebShare Webserver as well, for the next login.

CacheSize

int

30 (in MB)

Specifies the cache size value of the WebShare File Server for preview files. It corresponds to the Cache Size in MB value in the WebShare “Server Preferences” menu.

Hinweis:: The default value for CacheSize is 30 (MB), due to the usually limited disk space in “HELIOSDIR/var”. If you change the CacheDir preference to another path, it is recommended to set CacheSize to a value of at least 300 (MB).

AllowHostUsers

bool

TRUE

Specifies whether users are allowed to log on to the WebShare File Server with their host login name. The setting reflects that of the Enable WebShare for Host Users checkbox in the Webshare “Server Preferences” menu.

AllowVirtualUsers

bool

TRUE

Specifies whether users are allowed to log on to the WebShare File Server with their (virtual) WebShare login name. The setting reflects that of the Enable WebShare for Virtual Users checkbox in the Webshare “Server Preferences” menu.

AdminNotify

str

Specifies an e-mail address to which a notification is sent as soon as a client with Admin rights logs on to the WebShare File Server. It corresponds to the E-Mail Notification on Admin Login entry in the Webshare “Server Preferences” menu.

Hinweis:: Make sure that the complete receiver account is specified, e.g. webshare@mycompany.com

UserNotify

str

Specifies an e-mail address to which a notification is sent as soon as a user logs on to the WebShare File Server. It corresponds to the E-Mail Notification on User Login entry in the Webshare “Server Preferences” menu.

Hinweis:: Make sure that the complete receiver account is specified, e.g. webshare@mycompany.com

AllowAllReadWrite

bool

FALSE

If set to TRUE, this preference enables the sharepoint preferences AllRead and AllReadWrite. In that case, the additional options Always Allow Reading and Always Allow Read/Write (see 8.5.2 „Sharepoint preference keys“) will be shown in the “Sharepoint Administration” page.

Wichtig:: It may considerably reduce host security to set the AllowAllReadWrite flag to TRUE because if required, host access rights are bypassed, with all user processes changing to “root” processes!

DateFormat

str

"dd MMM yyyy kk:mm"

Specifies the format with which the date is displayed in the directory listing of the “Sharepoint” menu. It corresponds to the Directory Listing Date Format entry in the Webshare “Server Preferences” menu. Also, this preference specifies the required syntax for the Expires field in the “User Administration” page. See Datumsformat in 4.1 „Servereinstellungen“.

ProofProfiles

str

"CromalinEuro 1.0 UCR370,…"

Specifies those profiles from the “ICC-Profiles” volume that should be available in the ICC Proof Simulation pop-up menu in the WebShare proof window.

AllowUserICCProfiles

bool

FALSE

If this preference is set to TRUE, WebShare users are allowed to upload and administer their own monitor and printer ICC profiles on the “My User Preferences” administration page. It corresponds to the Allow ICC Profiles per User entry in the WebShare “Server Preferences” menu.

mail

bool

TRUE

Specifies whether e-mail notification is used at all.

SendMailOnActionScript

bool

FALSE

If set to TRUE, this preference sends an e-mail, as soon as a WebShare action script is executed, to the address that is specified in the E-Mail on Access field on the “Sharepoint Administration” page. See EmailAccess.

DefaultWindowsEncoding

str

"PC850"

Specifies the default encoding method when downloading files on Windows clients. The setting reflects that of the Default Windows Encoding pop-up menu on the “WebShare Server Preferences” menu.

DefaultMacintoshEncoding

str

"MacRoman"

Specifies the default encoding method when downloading files on Mac clients. The setting reflects that of the Default Mac OS Encoding pop-up menu in the WebShare “Server Preferences” menu.

ShowHiddenFiles

bool

FALSE

If set to TRUE, hidden files (“dot files” and files which have been marked as hidden in an EtherShare volume) are displayed in a sharepoint directory listing.

HideSpecialFiles

strlist

Specifies file names which should always be hidden in a directory listing.

PreviewResolutions

str

(see description)

Specifies the (comma-separated) pixel/resolution values which are available in the “Sharepoint” preview pop-up menu. The “zoom icon” resolution values are defined in the “Branding Editor > Branding > Preview Resolutions 1-4” preference, and are not affected by this preference.

By default, the following resolutions are available:

36 dpi,72 dpi,96 dpi,144 dpi,128 pixel,256 pixel,512 pixel,768 pixel,1024 pixel

CustomPreviewTypes

str

Allows specifying suffixes for custom file types that are to be previewed in WebShare and which must be processed first (according to the rules given in the “wspreview.pl” script). For example, doc,xls,ppt (no blanks!) can be specified for Microsoft Office documents which, if required, are processed by Tool Server with the “OfficeReader” script.

URLWebOnlyUsers

strlist

If this preference is set, the specified users have only URL based WebShare web access. See also the AllowLinkShares preference.

URLImageOnlyUsers

strlist

If this preference is set, the specified users have only URL based WebShare image fetching access. This allows setting up a special user (real or virtual) for remote URL image-only access. If somebody tries to steal the URL specified user name and password for a manual WebShare login, this will be denied. See also the AllowLinkShares preference.

Wichtig:: Specifying the same user name(s) with both preferences URLWebOnlyUsers and URLImageOnlyUsers will cause that the access for the specified user(s) is denied at all – be it via URL Share Access or manual login. So make sure to use different user names with both preferences!

The following keys require a restart (see “srvutil” in the HELIOS Base manual) of the service to take effect:

MaxUsersLimit

int

see description

Allows limiting the WebShare user count. The “Universal File Server” license allows access from EtherShare, PCShare, and WebShare. Each service counts against the “Universal User” count. So it is possible that many WebShare users use up all available user licenses, so that no EtherShare or PCShare login is possible anymore.

Hinweis:: Starting with 60 “Universal Users”, WebShare can be used with unlimited users. In this case, WebShare users do not affect EtherShare or PCShare logins, so it makes no sense to set this preference.

TcpPort

int

2010

Specifies the WebShare File Server port number. Additional TCP ports (up to a total of five) will automatically be allocated as needed by the WebShare File Server.

Wichtig:: The value of the TcpPort preference needs to be identical with the WebShare Webserver preference WSHostPort (7.6 „Präferenzen“). If there should be the need to change a value, then make sure that both preference keys are assigned the same value!

TelnetPort

int

2016

Specifies the “telnet” service port number of the WebShare File Server.

sessions

int

(see description)

Specifies the maximum number of workstations (clients) that are permitted to work on the WebShare File Server simultaneously. This value should normally be the same as the total number of workstations that are connected to the WebShare File Server, and should be less than or equal to the number of sessions allowed by your software license. The default value for sessions is the number of sessions allowed by your software license.

minuid

int

(see description)

Specifies the lowest number allowed for user IDs. All host users which have a lower user ID than that specified by minuid, and all virtual users running as a host user with a user ID lower than that specified by minuid, are not permitted to log in. The default behavior is that all IDs are allowed.

maxuid

int

(see description)

Specifies the highest number allowed for user IDs. All host users which have a higher user ID than that specified by maxuid, and all virtual users running as a host user with a user ID higher than that specified by maxuid, are not permited to log in. The default behavior is that all IDs are allowed.

ipaccess

str

"ipaccess"

Specifies the file containing the access list with the IP addresses which are permitted to log on to “websharesrv”. See HELIOS Base manual.

CacheDir

str

"var/tmp/wscache"

Specifies the directory which contains the preview files on the WebShare File Server. It corresponds to the Cache Directory entry in the “WebShare Server Preferences” menu.

Hinweis:: This directory must already exist and have rwx (read-write-execute) permissions for all.

AliasPDF

bool

TRUE

If set to FALSE, antialiasing for PDF previews is deactivated.

8.5.2 Sharepoint preference keys

The following keys take effect immediately:

: Key: Programs/websharesrv/Shares/<sharename>/<preference>

Path

str

Specifies the sharepoint path. It corresponds to the Sharepoint Path entry in “Sharepoint Administration”.

Publish

bool

TRUE

Specifies whether a sharepoint is published in the “Home” menu. The setting reflects that of the Publish checkbox in the “Sharepoint Administration” page.

EmailAccess

str

Specifies an e-mail address for notification mails on user access and action to the selected sharepoint. It corresponds to the E-Mail on Access entry on the “Sharepoint Administration” page. Make sure that the complete receiver account is specified, e.g.webshare@mycompany.com.

CollectMails

bool

TRUE

Specifies whether user action notification mails, as stated in the EmailAccess preference, are issued after the user has logged out, which is the default behavior, or – if set to FALSE – immediately after each file download, upload or deletion done by a user.

Hinweis:: If set to FALSE, no notifications for previews are issued at all because this would result in a flood of notification mails.

Comments

str

Specifies a comment on the selected sharepoint. It corresponds to the Comments entry on the “Sharepoint Administration” page.

AllowQuickshares

bool

FALSE

With this preference set to TRUE, Quickshares can be assigned to files organized in this sharepoint. The setting reflects that of the Allow Quickshares checkbox on the “Sharepoint Administration” page.

AllowAnnotations

bool

FALSE

With this preference set to TRUE, annotations can be added to a document. The setting reflects that of the Allow Annotations checkbox on the “Sharepoint Administration” page.

AllowPreview

bool

TRUE

Specifies whether previews of images in the sharepoint are allowed. The setting reflects that of the Allow Preview checkbox on the “Sharepoint Administration” page.

AllowDownload

bool

FALSE

Specifies whether downloading files from the sharepoint is allowed. The setting reflects that of the Allow Download checkbox on the “Sharepoint Administration” page.

AllowUpload

bool

FALSE

Specifies whether uploading files to the sharepoint is allowed. The setting reflects that of the Allow Upload checkbox on the “Sharepoint Administration” page.

AllowRename

bool

FALSE

Specifies whether renaming files and directories in the sharepoint is allowed. The setting reflects that of the Allow Rename checkbox on the “Sharepoint Administration” page. Setting this preference allows changing permissions, too.

AllowCopy

bool

FALSE

Specifies whether copying files to the sharepoint and creating directories is allowed. The setting reflects that of the Allow Copy checkbox on the “Sharepoint Administration” page.

AllowDelete

bool

FALSE

Specifies whether deleting files in the sharepoint is allowed. The setting reflects that of the Allow Delete checkbox on the “Sharepoint Administration” page.

AllRead

bool

FALSE

Specifies whether file read access in the sharepoint is enabled for all users, irrespective of the server file access settings. Read access includes file download and preview. The setting reflects that of the Always Allow Reading checkbox on the “Sharepoint Administration” page. This preference must first be enabled by the WebShare administration preference key AllowAllReadWrite.

AllReadWrite

bool

FALSE

Specifies whether file read/write access in the sharepoint is enabled for all users, irrespective of the server file access settings. Read/write access includes file download, upload and preview. The setting reflects that of the Always Allow Read/Write checkbox in the “Sharepoint Administration” page. This preference must first be enabled by the WebShare administration preference key AllowAllReadWrite.

OnlyLayouts

bool

FALSE

If set to TRUE, only layouts of the images in the sharepoint can be downloaded. The setting reflects that of the Download Layouts only checkbox in the “Sharepoint Administration” page. For this preference to be enabled, the WebShare File Server preference AllowDownload must be set to TRUE.

Users

strlist

Specifies one or more user names for which the sharepoint is available. If no names are specified, the sharepoint is available for all users. It corresponds to entries in Allowed Users on the “Sharepoint Administration” page.

Groups

strlist

Specifies one or more group names for whose members the sharepoint is available. If no names are specified, the sharepoint is available for all groups. It corresponds to entries in Allowed Groups on the “Sharepoint Administration” page.

For WebShare, the sharepoint (volume) key is the name of the sharepoint, for example “WebShare Public”, whereas for EtherShare and PCShare the volume key is the directory path, for example “/demovol”.

To set up a sharepoint “Mycompany Public”, similar to the “WebShare Public” by using “prefvalue”, the following prefvalue sequences must be called:

# prefvalue -k "Programs/websharesrv/Shares/Mycompany Public/
Path" -t str "/mycompany/public/WebShare"

# prefvalue -k "Programs/websharesrv/Shares/Mycompany Public/
AllowDownload" -t bool TRUE

# prefvalue -k "Programs/websharesrv/Shares/Mycompany Public/
AllowPreview" -t bool TRUE

By default, the Publish flag is set, therefore it need not be specified.

8.5.3 Quickshare preference keys

The following keys require a new login to take effect:

: Key: Programs/websharesrv/Quickshares/<QS #>/<preference>

Active: bool
FALSE; Specifies if a Quickshare is active. Setting a Quickshare status to FALSE, does not mean that the Quickshare is deleted but it is not available for remote users. The setting reflects that of the Active checkbox on the “Quickshare Administration” page.
Username: str
""; Specifies the name of the WebShare user to whom the Quickshare was assigned. The setting reflects the first part of the content of the Quickshare User pop-up menu on the “Quickshare Administration” page.
Sharepoint: str
""; This preference states the WebShare sharepoint that a Quickshare points to. The setting reflects the content of the Sharepoint text field on the “Quickshare Administration” page.
Path: str
""; This preference states the path that a Quickshare points to. The setting reflects the content of the Path text field in the “Quickshare Administration” page.
Expires: uint32
0; This preference allows you to enter an expiry date after which the Quickshare becomes void. The setting reflects the content of the Expires text field on the “Quickshare Administration” page.
Comment: str
""; This preference allows you to enter a comment for the remote Quickshare user. The setting reflects the content of the Comment text field on the “Quickshare Administration” page.
Creator: str
""; This preference states the creator of a Quickshare. The setting reflects the content of the Creator text field on the “Quickshare Administration” page.
CreatorEMail: str
""; Specifies the e-mail address of the logged-in user who created the Quickshare.
Files: strlist
""; This preference states the file(s) that are provided via the Quickshare link. The setting reflects the content of the Files text field on the “Quickshare Administration” page.
EMailOnAccess: bool
FALSE; If this preference is set to TRUE, the creator of a Quickshare is notified by e-mail if a user opens a Quickshare. The setting reflects the state of the E-Mail on Access checkbox on the “Quickshare Administration” page.
AllowDownload: bool
TRUE; If set to TRUE, this preference allows a Quickshare user to download files via Quickshare link. The setting reflects the state of the Allow Download checkbox on the “Quickshare Administration” page.
AllowUpload: bool
FALSE; If set to TRUE, this preference allows a Quickshare user to upload files via Quickshare link. The setting reflects the state of the Allow Upload checkbox on the “Quickshare Administration” page.
AllowPreview: bool
TRUE; If set to TRUE, this preference allows a Quickshare user to preview files via Quickshare link. The setting reflects the state of the Allow Preview checkbox on the “Quickshare Administration” page.
Random: str
""; Specifies a random suffix string for the Quickshare URL (compare Abb. 4.4). This prevents clients from accessing Quickshares with empty passwords (see QuickshareEmptyPassword above) by simply entering Quickshare IDs.

8.5.4 Web Server preference keys HELIOS Admin needs to know

The following keys require a new login on HELIOS Admin Server to take effect:

: Key: Programs/websharesrv/websharewoa/<webserver>/<preference>

When HELIOS Admin displays the “Quickshare” edit dialog, it includes information about the Web Server and URL.

If the WebShare File Server and Web Server are installed on different machines, HELIOS Admin needs to know the WebShare Web Server configuration for the following preference keys:

SSLPort
WOHost
WOPort
WSAllowedHostNames
WSHostName
WSHostPort
WSPublicHost

For <webserver> in the preference key use the complete WebShare Web Server name or IP address, e.g.:

Example 1: (using the complete WebShare Web Server name):; mywebserver.domain.com

Example 2: (using the complete WebShare Web Server IP address):; 172.16.3.29

If for example the WebShare Web Server has the changed SSLPort 4430, this would be the prefvalue call to set:

prefvalue -k "Programs/websharesrv/websharewoa/mywebserver.domain.com
   /SSLPort" -t int 4430

HELIOS Handbücher 29. September 2020