Wann man Inhaltstypen erstellen sollte

Also gut, Sie bauen in Plone Ihre Superanwendung, die Ihnen Ruhm und Ehre und noch dazu ein sicheres Einkommen einbringen wird. Wie werden Sie sie aber strukturieren, und was bauen Sie überhaupt? Nun, das hängt davon ab, was Sie machen wollen, und davon, wie Sie ihre Entwicklung bisher eingeteilt haben. Die folgenden Fragen helfen Ihnen möglicherweise bei der Entscheidung:

• Ändern Sie einfach nur Skins und einfache Verhalten, z.B. Portlets? Sie können in einer Skin fast alles machen, was Sie wollen, außer ein Werkzeug oder einen Inhaltstyp schreiben. Wenn Sie wirklich wollen, können Sie alle Cascading Stylesheets (CSS), Templates und Skripten ändern, die in einer Plone-Site enthalten sind.
• Werden Mitglieder Ihrer Site mehrere Kopien eines Elements hinzufügen? Wenn ja, dann möchten Sie wahrscheinlich einen Inhaltstyp dafür schreiben.
• Ist das ein Dienst, den andere Inhaltstypen benutzen könnten? Wenn ja, dann möchten Sie wahrscheinlich ein Werkzeug schreiben.
• Möchten Sie mehrere Kopien von etwas, wollen aber nicht, dass es Mitglieder Ihrer Site erstellen und bearbeiten können? Wenn ja, dann möchten Sie wahrscheinlich ein Zope-Objekt. Aber Sie sollten noch einmal genau darüber nachdenken, was Sie machen.

Normalerweise wird eine Anwendung in mehrere Teile aufgeteilt: ein bis zwei Werkzeuge und ein oder zwei Inhaltstypen. Kapitel 12 behandelt die Erstellung eines Inhaltstyps, der einen Source Code, z.B. einen Python-Schnipsel, nimmt und die Syntax des Codes hervorhebt. Falls Sie diese Syntax-Hervorhebung an anderen Stellen brauchen können, dann könnten Sie sie in ein Werkzeug verwandeln, das von mehreren Inhaltstypen verwendet werden kann. Werkzeuge sind, kurz gesagt, die beste Art, um Funktionalität zu einer Site statt zu einem bestimmten Inhaltstyp hinzuzufügen.

Die Definition der Erstellung eines Inhaltstyps wird normalerweise von den Anforderungen der Benutzer diktiert, die diese Objekte hinzufügen, bearbeiten und steuern müssen. Es kann verlockend sein, mit der Erstellung eines Inhaltstyps für jede Art von Objekt zu beginnen, aber wie bei jeder Art von Entwicklung müssen Sie vorsichtig sein. Wäre es möglich, einen statt zwei Inhaltstypen mit minimalen Unterschieden zu benutzen? Das Wissen darüber, wie man so etwas konfiguriert, kommt mit zunehmender Erfahrung, aber die folgenden paar Kapitel werden bestimmt eine Hilfe sein.

Inhaltstypen konfigurieren

Nun enthält Ihre Plone-Site also Inhaltstypen, aber woher weiß die Plone-Site, wie diese konfiguriert werden? Die Antwort lautet, dass Attribute, Methoden, Sicherheit und Skins für alle Inhaltstypen im Dateisystem in Python und im entsprechenden Code definiert werden. Diese Information genügt Plone, um zu wissen, wie das Produkt benutzt wird. Wie Sie gesehen haben, ist die einzige Ausnahme hiervon der Workflow, der normalerweise außerhalb des Inhaltstyps definiert wird. Manche Produkte haben ihren eigenen Workflow, der als Verhalten zum Inhaltstyp hinzugefügt wird.

In Kapitel 10 habe ich gezeigt, wie Inhaltstypen in zwei Schritten in Plone installiert werden: Zuerst wird das Produkt in Zope installiert, dann wird der Inhaltstyp in jeder Plone-Instanz installiert. Beim zweiten Schritt werden Angaben über den Inhaltstyp installiert, die aus dem Dateisystem stammen und dann in Ihrer Plone-Site installiert werden.

Warum besteht dieser Vorgang aus zwei Phasen? In der zweiten Phase wird eine lokale Kopie des Produkts in Ihrer Plone-Site angelegt, und nun können Sie ändern, wie sich der Inhalt bei Ihnen verhält. Möchten Sie, dass ein Dokumentobjekt andere Reiter oben hat? Oder soll ein Dokumentobjekt anders manipuliert werden, anders aussehen oder sogar völlig anders benannt werden? Kein Problem! Nun können Sie Ihre Plone-Instanz über das Web ändern.

Dieser Ansatz ist der gleiche wie bei portal_skins, in dem Sie eine Skin in Ihrer lokalen Instanz anpassen können. Wenn es im Produkt zu Änderungen kommt und Sie eine neue Version von Plone installieren, betreffen diese Änderungen das Dateisystem. Aber nun können Sie diese Änderungen herunterladen und installieren. Weil Sie die Angaben in Ihrer Datenbank gemacht haben, behalten Sie diese angepasste Version.

Jeder Inhaltstyp in Plone verfügt über eine Einstellung im Werkzeug portal_types. Auch wenn jeder Inhaltstyp nur eine Einstellung im Werkzeug portal_types hat, kann es zu diesem Typ eine unbeschränkte Anzahl von Objekten in Ihrer Datenbank geben. Die Konfiguration wird bei Bedarf zu Rate gezogen, d.h., wenn Sie die Konfiguration ändern, aktualisieren Sie alle Objekte dieses Typs in der Datenbank.

Registrierung von Inhaltstypen im Werkzeug portal_types

Gehen Sie im ZMI zum Werkzeug portal_types, um auf die Registrierungsinformation zuzugreifen. Dort erhalten Sie eine Liste aller in dieser Plone-Site registrierten Inhaltstypen. Die meisten davon sind als etwas zu erkennen, das Sie mit wenigen Ausnahmen über die Plone-Schnittstelle hinzufügen könnten, z.B. Plone Site, TempFolder usw.

Jedes dieser Objekte ist eine Instanz mit Angaben zum Factory-Typ, was der Name eines bestimmten Konfigurationstyps ist. Klicken Sie auf ein beliebiges dieser Objekte, um auf die Typinformation zuzugreifen. Wenn Sie z.B. ein Ereignis anklicken, erhalten Sie eine lokale Kopie der Information zu dem Inhaltstyp. Über das Web können Sie Ihre Konfiguration ändern. In diesem Formular gibt es folgende Einträge:

• Title: Der Titel des Inhaltstyps.
• Description: Die Beschreibung, die zu diesem Inhaltstyp erscheint. Diese wird benutzt, wenn Sie zu den Ordnerinhalten gehen und Neuen Artikel hinzufügen anklicken, ohne einen Inhaltstyp anzugeben. Dann erscheint eine Liste aller Inhaltstypen und ihrer Beschreibungen.
• Icon: Die ID des Icons, das für diesen Inhaltstyp benutzt wird.
• Product metatype: Der Metatyp für diesen Inhaltstyp. Dieser bildet den Plone-Inhaltstyp auf den Zope-Metatyp ab.
• Product name: Der Name des Produkts, in dem dieser Metatyp definiert ist.
• Product factory method: Die Methode, die von der Produkt-Factory aufgerufen wird, um diesen Inhalt zu erstellen.
• Initial view name: Wird in Plone nicht benutzt.
• Implicitly addable: Gibt an, ob dieser Inhalt zu Plone hinzugefügt werden kann. Wenn dieser Eintrag ausgewählt ist, kann der Inhalt hinzugefügt werden, außer es ist explizit etwas anderes angegeben.
• Filter content types: Falls dieser Inhaltstyp ein Ordner ist, aktivieren Sie das, um die Inhaltstypen zu filtern, die von Benutzern zu diesem Objekt hinzugefügt werden können.
• Allowed content types: Falls dieser Inhaltstyp andere Elemente enthalten kann und Filter content types aktiviert ist, sind nur die in dieser Liste angegebenen Inhaltstypen erlaubt.
• Allow discussion: Setzt den voreingestellten Status für Diskussionen bei allen Inhaltstypen. Falls dieser Eintrag aktiviert ist, können Benutzer den Inhalt diskutieren. Welche Benutzer das tun können, hängt von dem Recht Discuss content ab.

Nun werden Sie sich einige Aspekte dieser Registrierungsangaben detaillierter anschauen, wobei ich auch einige Beispiele zeige.

actions = context.portal_actions.listFilteredActionsFor(object)

{'site_actions': [
  {'category': 'site_actions', 'name': 'Small Text',
  'url': "javascript:setActiveStyleSheet('Small Text', 1);",
  'visible': 1, 'id': 'small_text',
  'permissions': ('View',)
   },
... und so weiter

{'category': 'object',
'name': 'Contents',
'url': ' http://localhost:8080/Plone/folder_contents',
'visible': 1,
'id': 'folderContents',
'permissions': ('List folder contents',)},
... und so weiter

Speichern von Inhaltstypinformationen im Dateisystem

Nun haben Sie gesehen, wie diese Information in Zope gespeichert wird, aber natürlich kommt sie irgendwoher aus dem Dateisystem. Diese Information wird normalerweise im Produkt in einem Dictionary gespeichert, das üblicherweise factory_type_information heißt. Listing 11.1 zeigt diese Factory-Information zu dem Produkt Folder, einem Produkt, das Ordner in Plone anzeigt. Sie stammt aus der Datei PloneFolder.py im Verzeichnis CMFPlone.

Listing 11.1. Factory-basierte Typinformation

factory_type_information = {
    'id':'Folder',    'meta_type':'Plone Folder',
    'description':"""\
Plone folders can define custom 'view' actions,\
 or will behave like directory listings without one defined.""",
    'icon':'folder_icon.gif',
    'product':'CMFPlone',    'factory':'addPloneFolder',
    'filter_content_types':0,
    'immediate_view':'folder_listing',    'actions':
      ( {
           'id':'view',           'name':'View',
           'action':'string:${folder_url}/',           'permissions':
(CMFCorePermissions.View,),           'category':'folder',         }
    ...
      )
    }

Das Python-Dictionary bildet die Formulare ab, die Sie in der Plone-Schnittstelle gesehen haben. So ist z.B. 'meta_type': 'Plone Folder' der meta_type des Produkts und erscheint in diesem Feld. Die Aktionen erscheinen als Liste von Dictionaries zu jeder Aktion, und es sind wiederum einfache Schlüssel/Wert-Paare für alle Eigenschaften einer Aktion. Hier habe ich nur die erste Aktion, View, angegeben, aber mittlerweile sollte Ihnen diese Art von Angaben vertraut vorkommen.

Einen neuen Inhaltstyp aus einem vorhandenen Typ erstellen

Unter Umwidmen versteht man die Erstellung mehrerer, leicht verschiedener Kopien des gleichen Typs, ausgehend von der Information eines vorhandenen Inhaltstyps. Eine Umwidmung kann dann eine schnelle und einfache Lösung sein, wenn Sie z.B. einen Typ erstellen möchten, der fast, aber nicht ganz, mit einem Nachrichtenelement identisch ist.

Der große Nachteil dieses Ansatzes ist der, dass Sie außer den Aktionen, Skins und einigen Inhaltstyp-Einstellungen nicht wirklich viel ändern können. Bevor Sie also auf diesem Weg weitermachen, machen Sie sich bitte klar, dass Sie auf diese Punkte beschränkt sind, d.h., Sie können z.B. keine neuen Felder oder Attribute hinzufügen. Auf der Mailing-Liste habe ich viele E-Mails gesehen, in denen ungefähr Folgendes steht: "Ich habe schon so viel gemacht, aber nun will ich die Attribute meiner Pressemitteilung ändern." Nehmen Sie das als Warnung: Das geht nicht! Wenn Sie mehr machen möchten, sehen Sie sich die nächsten beiden Kapitel an, in denen steht, wie Sie eigene Inhaltstypen schreiben können.

Angenommen, Sie möchten einen Typ Pressemitteilung haben, der einer Nachricht ähnelt, aber auch noch Folgendes macht:

• Er hat den Namen Pressemitteilung in der Dropdown-Liste.
• Er hat ein anderes Icon.
• Er hat einen anderen Workflow als Nachrichtenelemente.
• Er wird anders angezeigt.
• Er hat die gleichen Datenstrukturen wie ein Nachrichtenelement.
• Er behält den Typ eines Nachrichtenelements.

Nun, in diesem Fall ist die Umwidmung eines Inhaltstyps ideal. Nehmen Sie in diesem Beispiel die Factory-basierte Typinformation eines Nachrichtenelements, laden Sie sie in das Werkzeug portal_types, und nennen Sie sie dann Pressemitteilung. Dadurch können Sie den gesamten vorhandenen Code und die Information wiederbenutzen, während Sie auch neue Möglichkeiten haben. Gehen Sie im ZMI zu portal_types, und führen Sie folgende Schritte aus:

1. Wählen Sie Factory-based Type Information.
2. Geben Sie als ID Pressemitteilung ein, und wählen Sie CMF Default: News Item im Feld Use default type information.
3. Klicken Sie auf Add, um dieses Formular zu beenden.

Das ist nun eine Instanz der Konfiguration eines Nachrichtenelements, heißt aber Pressemitteilung. Welchen Vorteil haben Sie davon? Nun, Sie haben jetzt einen weiteren Objekttyp, den Benutzer über das Web hinzufügen können. Damit haben die Benutzer Ihrer Site eine wirklich einfache Möglichkeit, zwischen einer Nachricht und einer Pressemitteilung zu unterscheiden, ohne sich mit Stichwörtern oder Metadaten herumschlagen zu müssen. Diese Objekte erscheinen nun auch bei Suchvorgängen und an allen anderen Stellen als Pressemitteilungen. Nun können Sie die Konfiguration der Pressemitteilung ändern, ohne dass es einen Einfluss auf die Konfiguration von Nachrichten hätte.

Änderungen am Icon wurden in diesem Kapitel bereits angesprochen: Laden Sie das Bild einfach in Ihr Verzeichnis, und ändern Sie dann für eine Pressemitteilung die Icon-Eigenschaft auf der Seite portal_types. Wenn Sie zum portal_workflow gehen, sehen Sie, dass alle Inhaltstypen einen eigenen Workflow haben. Da Sie nun einen neuen Inhaltstyp haben, können Sie gezielt den Workflow von Pressemitteilungen ändern. Vielleicht benötigen Pressemitteilungen eine zusätzliche Überprüfung, oder sie senden nach ihrer Veröffentlichung E-Mails an bestimmte Benutzer. Nun können Sie einen neuen Workflow erstellen, wie ich es in Kapitel 8 gezeigt habe, und ihn an Ihre Pressemitteilungen zuweisen.

Eine neue Anzeige hinzuzufügen bedeutet, das Page Template newsitem_view anzupassen und in etwas Sinnvolles umzubenennen, z.B. in pressrelease_view. Vielleicht möchten Sie diese Datei ändern, um am Seitenende einige Angaben über die Firma zu machen. Beispiel:

<h2>About ACME Widget Company</h2>
<p>Our company is the prime maker of widgets in the world. Founded
in 1980 we've been providing excellent widgets to all parts of the
globe. For more marketing information, please contact: Joe Bloggs,
marketing director.</p>

Nachdem Sie Ihre Änderungen an Ihrem neuen Page Template gespeichert haben, gehen Sie zu den Einstellungen der Pressemitteilung in portal_types zurück und gehen dort auf die Actions-Seite. Ändern Sie die Aktion für die Anzeige einer Pressemitteilung von newsitem_view in pressrelease_view. Immer, wenn Sie nun eine Pressemitteilung anzeigen, wird diese Anzeigeseite angezeigt, wie auch in Abbildung 11.1 zu sehen ist.

Abbildung 11.1. Ein in Plone geladenes Beispiel-Python-Skript

In diesem Fall habe ich ein Pressemitteilungsobjekt hinzugefügt, und die Fußzeile über ACME Company befindet sich im Template, d.h., die Benutzer müssen sie nicht immer eingeben.

Ein Skripting-Objekt erstellen

Sobald ein Objekt im Werkzeug portal_types registriert ist, können Sie dann Objektinstanzen davon in Ihrer Plone-Site erzeugen. Die Erzeugung solcher Objekte können Sie auch programmgesteuert mit Skripten durchführen. Das ist beim Erstellen von Objekten nützlich, die auf bestimmten anderen Faktoren basieren oder wenn Objekte en masse erzeugt werden. Plone hat zu diesem Zweck zwei nützliche Script (Python)-Objekte:

• generateUniqueId: Dies erzeugt eine neue eindeutige ID für diesen Objekttyp, z.B. Folder.2003-12-19.7359814582. Sie ist nur in dem Ordner eindeutig, in dem sie erzeugt wird. Wenn Sie schnell viele Objekte erzeugen, kann es sein, dass diese nicht eindeutig sind. Aber im Normalfall ist das gut genug.
• invokeFactory: Dies erwartet eine ID und einen Typnamen. Es erzeugt ein Objekt des angegebenen Typs und weist ihm die angegebene ID zu.

Nun werden Sie ein Beispielskript erstellen, das einen Ordner und eine Standardseite darin erzeugt, und in dieser Standardseite setzen Sie einen bestimmten Inhalt. Wenn Ihnen das bekannt vorkommt, dann vielleicht deswegen, weil das immer dann passiert, wenn Sie Mitglied auf einer Site werden und für Sie ein Home-Verzeichnis angelegt wird. Die Typnamen entsprechen der Registrierung im Werkzeug portal_types. Das heißt, wenn Sie einen Ordner erzeugen und ein Dokument darin platzieren möchten, dann müssen Sie die Parameter Folder und Document an das Skript invokeFactory übergeben.

Listing 11.2 zeigt ein Skript, das sich eine eindeutige ID holt und einen Ordner auf Basis dieser ID erstellt. Dann erstellt es in diesem Ordner ein neues Dokument.

Listing 11.2. Holen einer ID und Erstellen eines Ordners

##title=Create
##parameters=
# create with a random id
newId = context.generateUniqueId('Folder')
 
# create a object of type Folder
context.invokeFactory(id=newId, type_name='Folder')
newFolder = getattr(context, newId)
 
# create a new Document type
newFolder.invokeFactory(id='index.html', type_name='Document')
 
# get the new page
newPage = getattr(newFolder, 'index.html')
newPage.edit('html', '<p>This is the default page.</p>')
 
# return something back to the calling script
return "Done"

Wenn Sie das als Script (Python)-Objekt hinzufügen und es im Test-Reiter testen, wird ein Ordner für Sie erzeugt. Interessanterweise werden der Ordner und das Dokument im aktuellen Kontext erzeugt, was auch immer das Kontextobjekt sein mag.

Das Inhaltstyp-Register

Ich habe Ihnen eine Vielzahl verschiedener Zugriffsarten auf Plone gezeigt, z.B. FTP und WebDAV. Wenn Plone Inhalte über einen dieser Zugangswege empfängt, muss es mit diesen Inhalten in der passenden Weise umgehen. Dafür sorgt das Inhaltstyp-Register, das Sie im ZMI unter dem Werkzeug content_type_registry sehen können. Wenn Sie dieses Werkzeug in Zope aufsuchen, werden Sie wahrscheinlich von einem weiteren schlecht entworfenen Formular im ZMI geblendet, aber lassen Sie sich davon nicht entmutigen!

Wenn ein Inhalt über FTP oder WebDAV in Plone hinzugefügt wird, werden die Regeln im Register von oben nach unten ausgeführt, bis eine Übereinstimmung erfolgt. Diese basiert auf den Kriterien dieser Regel, und bei einer Übereinstimmung wird der entsprechende Inhaltstyp für diese Regel erzeugt. Folgendes sind die vier verschiedenen Arten von Kriterien:

• major_minor: Nimmt die zwei Teile (links und rechts vom Schrägstrich) des MIME-Typs (Multipurpose Internet Mail Extensions) einer empfangenen Datei und führt darauf den Vergleich aus. Wenn Sie einen Teil leer lassen, passt dieser auf alles. Ein major_minor mit dem Wert image `` (beachten Sie das eine Leerzeichen rechts) passt z.B. auf ``image/jpeg, image/gif, image/png usw.
• extension: Passt zur Dateinamenserweiterung. Alle Erweiterungen werden mit einem Leerzeichen voneinander getrennt. Das heißt, doc pdf passt auf rechnungen.doc und bericht.pdf.
• mimetype_regex: Führt einen Vergleich mit einem regulären Ausdruck auf dem MIME-Typ durch. Das heißt, *,^j passt auf image/jpeg, image/jpg, application/java usw.
• name_regex: Führt einen Vergleich mit einem regulären Ausdruck auf dem Dateinamen aus. Zum Beispiel passt ^Rechnung auf Rechnung-123.pdf, aber nicht auf Keine_Rechnung-123.pdf.

Um einen Typ hinzuzufügen, geben Sie den Namen der Regel und den Typ aus dem Dropdown-Menü im Formular am Seitenende ein und klicken auf Add. Dadurch wird am Seitenende eine Regel erstellt. In dieser Regel können Sie ein Muster eingeben, das mit der von Ihnen erstellten Art von Regel übereinstimmt, und den gewünschten Inhaltstyp in der Dropdown-Liste wählen. Dann können Sie Up und Down anklicken, um Ihren Eintrag jeweils nach oben und unten zu verschieben, um dessen Priorität zu verändern.

Ein Beispiel: Neulich habe ich eine digitale Kamera gekauft, und da das Installationsprogramm von Plone unter Windows auch CMFPhoto und PIL einrichtet, dachte ich, ich könnte aus meinen Bildern mit geringem Aufwand ein Online-Fotoalbum erstellen. Zuerst habe ich den FTP-Server aktiviert und bin dann zur Inhaltstyp-Registry gegangen, wo ich eine neue Regel erstellt habe, die von der Erweiterung abhängt, die image/jpeg auf den Inhaltstyp photo abbildet. Dann habe ich diese Regel nach oben über die vorhandene Regel für Bilder verschoben. Anschließend musste ich nur noch meine Fotos in meinen FTP-Client ziehen, und schon wurden sie automatisch in Plone geladen, mit Miniaturbildchen versehen und angezeigt.

Inhalte indizieren

Als Erstes muss der Katalog Indizes vom Inhalt erstellen. Ein Index bietet vor allem eine Methode, um schnell und effizient im Inhalt zu suchen. Daher muss der Index-Inhalt für den Benutzer nicht klar sein oder Sinn machen. Er muss nur die schnelle und effiziente Suche ermöglichen. Wenn Sie in einer Plone-Site suchen, dann suchen Sie in den Indizes, und der Katalog gibt die zur Anfrage passende Ergebnisliste zurück.

Ein Index fragt ein Plone-Objekt nach einem bestimmten Wert ab, z.B. nach einer Methode oder einem Attribut, und indiziert dann, was immer dieses Objekt bei dieser Anfrage zurückgibt. Wie es den Inhalt tatsächlich indiziert, hängt von der Art des Indexes ab. Tabelle 11.1 führt alle in Plone verfügbaren Indizes auf.

Tabelle 11.1. Verfügbare Index-Typen

Welche Indizes in einem Katalog definiert sind, können Sie sehen, wenn Sie auf portal_catalog klicken und den Indexes-Reiter wählen. Dann erhalten Sie eine Liste aller in Ihrer Plone-Site definierten Indizes. Die Spalten enthalten den Indexnamen, den Typ, die Anzahl der Treffer und den Zeitpunkt der letzten Änderung im Index. Die verschiedenen Indextypen wurden zuvor kurz behandelt, aber in Tabelle 11.2 finden Sie eine Beschreibung aller Standardindizes einer Plone-Site.

Tabelle 11.2. In Plone eingerichtete Standardindizes

Wenn Sie einmal nicht genau wissen sollten, was in einem Index enthalten ist, können Sie sich im ZMI dessen Inhalt anschauen. Klicken Sie auf portal_catalog, und wählen Sie Catalog, womit Sie eine Liste aller gerade katalogisierten Objekte erhalten. Klicken Sie auf ein Objekt, und es erscheint ein Fenster mit dem Inhalt des Indexes und der Metadaten. Die Metadaten kommen zuerst, d.h., Sie müssen nach unten scrollen, um die Indizes zu sehen.

Um Indizes zu ändern, zu löschen oder hinzuzufügen, gehen Sie zum Indexes-Reiter zurück. Benutzen Sie das normale Dropdown-Menü namens Add, um einen neuen Index hinzuzufügen oder einen zu löschen. Wenn Sie einen bestimmten Index neu erstellen möchten, wählen Sie links die gewünschten Indizes und klicken auf den Button Reindex. Wenn Sie einen Index zum Katalog hinzufügen, hat er zunächst keinen Inhalt, d.h., Sie müssen dann auf den Button Reindex klicken, um sicherzugehen, dass Ihr Index auch einen Inhalt hat.

Metadaten

Die vom Katalog zurückgegebenen Ergebnisse sind nicht die gefundenen Objekte, sondern die dazu im Katalog gefundenen Metadaten. Diese Metadaten bestehen aus einer Reihe von Feldern oder Spalten für alle Werte im Objekt. Entsprechend wird für eine Plone-Site eine Liste von Spalten erzeugt, wie es in Tabelle 11.3 beschrieben ist.

Tabelle 11.3. In Plone verfügbare Standard-Metadaten

Wie Objekte indiziert werden

Inhaltstypen werden automatisch indiziert, weil sie von einer Klasse namens PortalContent erben, die ihrerseits von einer Klasse namens CMFCatalogAware erbt. Die Klasse CMFCatalogAware enthält den gesamten Code, der sicherstellt, dass beim Hinzufügen, Bearbeiten, Ausschneiden, Kopieren, Löschen oder Umbenennen eines Objekts der Katalog (und ebenso der Workflow) aktuell sind. Das Objekt wird im Wesentlichen an den Katalog übergeben, wo die passende Anweisung aufgerufen wird (indizieren, aus dem Index entfernen usw.).

Der Katalog geht dann alle Indizes durch und fragt alle aus dem Objekt mit Hilfe der Attribute oder Methoden des Objekts ab. Bei den meisten Indizes ist der Name des gesuchten Attributs bzw. der gesuchten Methode identisch mit dem des Indexes. Beim Indexnamen Title würde er nach einem Attribut oder einer Methode namens Title suchen und im Index das Ergebnis ablegen. Dann setzt er diesen Vorgang mit allen anderen Metadatenspalten fort.

Zwei Ausnahmen bei diesem Vorgang sind die Typen FieldIndex und TopicIndex. Wenn Sie einen FieldIndex hinzufügen, können Sie angeben, dass der Index einen anderen Wert als den Namen des Indexes untersucht. Sie könnten z.B. einen Index mit der ID getVersion anlegen, der Versionswerte untersucht. Wie Sie später noch sehen werden, haben manche Indizes Vorteile gegenüber anderen, d.h., es kann sinnvoll sein, verschiedene Indizes für den gleichen Wert zu haben.

TopicIndex ist insofern ein anderer Indextyp, als er bei der Erstellung des Inhaltsindexes eine Reihe von Mengen bildet. Wenn Sie viele Suchvorgänge auf allen Bildern durchführen möchten, könnten Sie eine Suche nach o.portal_type == 'Image' hinzufügen. Dazu müssen Sie einen TopicIndex erstellen und dann im Indexes-Reiter auf den Index klicken. Sie können einen Index sogar mit mehreren Ausdrücken erstellen. In Plone wird momentan nirgendwo ein TopicIndex verwendet.

Suchen im Katalog

Die wichtigste Frage ist natürlich die, wie man im Katalog sucht und dessen Ergebnisse nutzt. Der erste Teil dieser Aufgabe hängt von den Indizes ab, daher behandle ich alle Indizes und zeige Ihnen, wie man darin sucht. Der zweite Teil beinhaltet die Manipulation der Ergebnisse, die ich Ihnen anschließend auch zeigen werde.

Alle folgenden Beispiele sind in Python geschrieben, weil dies die beste Art ist, in einem Katalog zu suchen. Ich zeige Ihnen auch schnell ein Beispiel dafür, wie man das in ein Page Template einbaut. Ich möchte Ihnen nahe legen, Python für die Manipulation des Katalogs einzusetzen, weil es wirklich der beste Platz mit der höchsten Flexibilität ist, um etwas zu machen, ohne sich um die Syntax sorgen zu müssen.

Ganz allgemein bewerkstelligen Sie eine Suche dadurch, dass Sie die Methode searchResults auf dem Objekt portal_catalog aufrufen und dabei eine Reihe von Schlüsselwortparametern übergeben. Zwar gibt es ein paar reservierte Schlüsselwörter, aber der Rest wird direkt auf die Indizes gleichen Namens abgebildet. Wenn Sie also z.B. im Index SearchableText suchen möchten, würden Sie der Suchmethode den Schlüsselwortparameter für SearchableText übergeben. Folgendes sind die reservierten Schlüsselwörter:

• sort_on: Dies ist der Index, mit dem die Ergebnisse sortiert werden sollen, vorausgesetzt, dass der Index eine Sortierung erlaubt (Volltext-Indizes tun das nicht).
• sort_order: Hat einen der Werte reverse oder descending. Wenn nichts angegeben ist, lautet die Voreinstellung ascending.
• sort_limit: Dies ist ein Optimierungshinweis, um die Sortierung etwas zu beschleunigen.

Eine allgemeine Suche nach allen Elementen, in denen Plone erwähnt wird, und die in der Reihenfolge von Date veröffentlicht sind, sieht ungefähr wie folgt aus:

context.portal_catalog.searchResults(
    review_state = "published",
    SearchableText = "Plone",
    sort_order = "Date"
)

Die Suche gibt die Schnittmenge der Indexergebnisse zurück, d.h., es werden alle Elemente gefunden, die Plone erwähnen und die veröffentlicht sind. Sie können keine Suche mit der Vereinigungsmenge von Ergebnissen durchführen, aber Sie könnten mehrere Ergebnisse bekommen und diese zusammensetzen, was allerdings ein eher unüblicher Fall ist.

results = context.portal_catalog.searchResults(
    Type = "Image"
)

from DateTime import DateTime
now = DateTime()
results = context.portal_catalog.searchResults(
       Type = "Event"
       end = { "query": [now,],
                "range": "min" }
)

from DateTime import DateTime
start = DateTime('2004/12/01')
end = DateTime('2004/12/31')
results = context.portal_catalog.searchResults(
        Type = "News Item",
        created = { "query": [start, end],
                         "range": "minmax" }
)

results = context.portal_catalog.searchResults(
        Subject = "Afrika"
)

results = context.portal_catalog.searchResults(
        Subject = { "query": ["Afrika", "Sonne"],
                     "operator": "and" }
)

results = context.portal_catalog.searchResults(
        path = "/Plone/Members"
)

results = context.portal_catalog.searchResults(
        path = { "query": ["danae"],
                "level" : 2 }
)

results = context.portal_catalog.searchResults(
        SearchableText = "space"
)

results = context.portal_catalog.searchResults()
for result in results:
    print result.getId
return printed

results = context.portal_catalog.searchResults()
for result in results:
    object = result.getObject()
    print object
return printed

results = context.portal_catalog.searchResults()
print "Anzahl der Ergebnisse", len(results)
return printed

results = context.portal_catalog.searchResults()
return results[:10]

results = context.portal_catalog.searchResults()
for result in results[:10]:
    # Title returns a string so we can use the find method of
    # a string to look for occurence of a word
    if result.Title.find("Plone") > -1:
        print result.Title
return printed

import random
results = context.portal_catalog.searchResults()
r = random.choice(results)
object = r.getObject()
return object

Alles zusammen: Erstellen eines Suchformulars

In den vorangegangenen Betrachtungen habe ich Ihnen gezeigt, wie Sie einige Ergebnisse aus dem Katalog bekommen, und ich habe Script (Python)-Objekte benutzt, um das zu demonstrieren. Aber vermutlich fragen Sie sich, wie Sie das aus einem Page Template tun können?

Ich fange am anderen Ende an und nehme zuerst an, dass Sie die Ergebnisse aus einer Kataloganfrage schon haben und in einem Page Template mit tal:repeat darüber iterieren. Auf diese Weise funktionieren eine Menge Portlets, auch die für zuletzt veröffentlichte Elemente und Ereignisse, die beide lediglich den Katalog abfragen und dann die Ergebnisse anzeigen. Diese Portlets betten die Abfrage in einem Page Template ein, entweder, indem sie dieses direkt aufrufen:

<div tal:define="results python: here.portal_catalog.searchResults(Type="Event")">

oder indem sie ein separates Script (Python)-Objekt aufrufen, das die Ergebnisse zurückgibt. Im folgenden Beispiel heißt das Skript getCatalogResults:

##parameters=
kw = {}
# enter your query into the kw dictionary
return context.portal_catalog(**kw)

In einem Page Template würden Sie die Ergebnisse auf folgende Weise erhalten:

<div tal:define="results here/getCatalogResults">

Danach müssen Sie mit der normalen tal:repeat-Syntax über die Ergebnisse iterieren. Auf alle Metadatenspalten können Sie direkt in TAL (Template Attribute Language) mit einem Pfadausdruck auf die Spalte zugreifen. Mit einem gegebenen Hirn könnten Sie mit einem Aufruf von result/Title den Titel aus den Metadaten ermitteln. Listing 11.3 zeigt eine Beispielseite, die über den Inhalt von getCatalogResults iteriert und jedes Element in einer einfachen ungeordneten Liste anzeigt.

Listing 11-3. Iterieren über getCatalogResults

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US"
      lang="en-US"
      metal:use-macro="here/main_template/macros/master"
      i18n:domain="plone">
<body>
<div metal:fill-slot="main">
<ul tal:define="results here/getCatalogResults">
    <li tal:repeat="result results">
        <a href=""
           tal:attributes="href result/getURL"
           tal:content="result/Title" />
        <span tal:replace="result/Description" />
    </li>
</ul>
</div>
</body>
</html>

Ein Merkmal der Methode searchResults ist, dass sie bei einem Aufruf ohne Parameter in der ankommenden Abfrage nach diesen sucht. Wenn Sie also möchten, dass ein Formular Parameter zu Ihren Ergebnissen hinzufügt, müssen Sie nur die vorherige Ergebniszeile wie folgt ändern:

<ul tal:define="
 
  results python: here.portal_catalog.searchResults(REQUEST=request)
  ">

Nun können Sie Ihre Abfrage erneut ausführen und einen beliebigen Index zur URL hinzufügen. Wenn Sie dieses Page Template z.B. testResults nennen und in Ihrem Browser ans Ende der URL ?Type=Document hinzufügen, würden nur die Dokumente in Ihrer Site erscheinen. Da Sie fast alle Abfragewerte übergeben können, können Sie ein Suchformular so einrichten, dass diese Information zum Suchformular durchgereicht wird. Genau das machen die Seiten zur Suche und zur erweiterten Suche. Wenn Sie auf eine Plone-Site gehen und in dem Suchkasten nach Wein suchen, werden Sie bemerken, dass Ihre URL nun ?SearchableText=Wein enthält.

Listing 11.4 zeigt ein Formular zum Aufrufen Ihrer Page Templates.

Listing 11.4. Ein Formular zum Aufrufen Ihres Templates

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US"
      lang="en-US"
      metal:use-macro="here/main_template/macros/master"
      i18n:domain="plone">
<body>
<div metal:fill-slot="main">
  <p>Select a content type to search for</p>
  <form method="post" action="testResults">
    <select name="Type">
      <option
       tal:repeat="value python:here.portal_catalog.uniqueValuesFor('Type')"
       tal:content="value" />
        </select>
        <br />
        <input type="submit" class="context">
    </form>
</div>
</body>
</html>

Dieses Skript benutzt eine Methode namens uniqueValuesFor im Katalog, die alle eindeutigen Werte zurückgibt, die in einem Index existieren. Damit können Sie eine Aufgabe wie das Ausfüllen eines kleinen Dropdown-Menüs in einem Formular erledigen, was sehr nützlich ist.

An diesem Punkt wird es zu einer Übung in HTML und Page Templates, Ihre Seiten so komplex zu machen, wie Sie es wünschen. Der beste Platz, um all das nachzuschauen, ist natürlich in den echten Templates von Plone, die viele Zeilen mit tollen Beispielen enthalten. Alle Portlets, die Sie in Plone kennen (z.B. der Kalender, die Ereignisse, Dazu passend usw.) sind so aufgebaut, dass Sie Katalogabfragen benutzen, um zu bestimmen, was angezeigt werden soll.

In diesem Kapitel habe ich Ihnen einen Überblick über Methoden gezeigt, um eine Plone-Site zu entwickeln, und ich habe gezeigt, wie Inhaltstypen in Ihrer Site funktionieren. Außerdem habe ich vorgeführt, wie ein Inhaltstyp gebaut und dann über den Katalog referenziert wird. In Plone ist das eine sehr wichtige Entwicklungsstrategie.

Im nächsten Kapitel werde ich zeigen, wie man einen neuen Inhaltstyp mehr oder weniger bei null beginnend erstellt. Und Sie werden sehen, wie Sie diesen neuen Inhaltstyp mit dem Katalogregister im Werkzeug portal_types integrieren können.