;;; eudc-vars.el --- Emacs Unified Directory Client;; Copyright (C) 1998 Free Software Foundation, Inc.;; Author: Oscar Figueiredo <oscar@xemacs.org>;; Maintainer: Oscar Figueiredo <oscar@xemacs.org>;; Created: Feb 1998;; Version: $Revision$;; Keywords: help;; This file is part of XEmacs;; XEmacs is free software; you can redistribute it and/or modify it;; under the terms of the GNU General Public License as published by;; the Free Software Foundation; either version 2, or (at your option);; any later version.;; XEmacs is distributed in the hope that it will be useful, but;; WITHOUT ANY WARRANTY; without even the implied warranty of;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU;; General Public License for more details.;; You should have received a copy of the GNU General Public License;; along with XEmacs; see the file COPYING. If not, write to ;; the Free Software Foundation, Inc., 59 Temple Place - Suite 330,;; Boston, MA 02111-1307, USA.;;; Code:(require'custom);;{{{ EUDC Main Custom Group(defgroupeudcnil"Emacs Unified Directory Client.":group'mail:group'comm)(defcustomeudc-servernil"*The name or IP address of the directory server.A port number may be specified by appending a colon and anumber to the name of the server. Use `localhost' if the directoryserver resides on your computer (BBDB backend).":type'(string:tag"Server"):group'eudc);; Known protocols (used in completion);; Not to be mistaken with `eudc-supported-protocols'(defvareudc-known-protocols'(bbdbphldap))(defvareudc-supported-protocolsnil"Protocols currently supported by EUDC.This variable is updated when protocol-specific librariesare loaded, *do not change manually*.")(defcustomeudc-protocolnil"*The directory protocol to use to query the server.Supported protocols are specified by `eudc-supported-protocols'.":type`(choice:menu-tag"Protocol",@(mapcar(lambda(s)(list'const':tag(symbol-names)s))eudc-known-protocols)):group'eudc)(defcustomeudc-strict-return-matchest"*Ignore or allow entries not containing all requested return attributes.If non-nil, such entries are ignored.":type'boolean:group'eudc)(defcustomeudc-default-return-attributesnil"*A list of default attributes to extract from directory entries.If set to the symbol `all', return all attributes.A value of nil means return the default attributes as configured in theserver.":type'(choice:menu-tag"Return Attributes"(const:menu-tag"Server defaults (nil)"nil)(const:menu-tag"All"all)(repeat:menu-tag"Attribute list":tag"Attribute name":value(nil)(symbol:tag"Attribute name"))):group'eudc)(defcustomeudc-multiple-match-handling-method'select"*What to do when multiple entries match an inline expansion query.Possible values are: `first' (equivalent to nil) which means keep the first match only,`select' pop-up a selection buffer,`all' expand to all matches,`abort' the operation is aborted, an error is signaled.":type'(choice:menu-tag"Method"(const:menu-tag"Use First":tag"Use First"first)(const:menu-tag"Select Interactively":tag"Select Interactively"select)(const:menu-tag"Use All":tag"Use All"all)(const:menu-tag"Abort Operation":tag"Abort Operation"abort)(const:menu-tag"Default (Use First)":tag"Default (Use First)"nil)):group'eudc)(defcustomeudc-duplicate-attribute-handling-method'((email.duplicate))"*A method to handle entries containing duplicate attributes.This is either an alist (ATTR . METHOD) or a symbol METHOD.The alist form of the variable associates a method to an individual attribute,the second form specifies a method applicable to all attributes.Available methods are:`list' or nil lets the value of the attribute be a list of values,`first' keeps the first value and discards the others,`concat' concatenates the values into a single multiline string,`duplicate' duplicates the entire entry into as many instances as different values.":type'(choice(const:menu-tag"List"list)(const:menu-tag"First"first)(const:menu-tag"Concat"concat)(const:menu-tag"Duplicate"duplicate)(repeat:menu-tag"Per Attribute Specification":tag"Per Attribute Specification"(cons:tag"Attribute/Method":value(nil.list)(symbol:tag"Attribute name")(choice:tag"Method":menu-tag"Method"(const:menu-tag"List"list)(const:menu-tag"First"first)(const:menu-tag"Concat"concat)(const:menu-tag"Duplicate"duplicate))))):group'eudc)(defcustomeudc-inline-query-format'((name)(firstnamename))"*Format of an inline expansion query.This is a list of FORMATs. A FORMAT is itself a list of one or more EUDC attribute names. A FORMAT applies if it contains as many attributes asthere are individual words in the inline query string.If several FORMATs apply then they are tried in order until a match is found. If nil, all the words are mapped onto the default server or protocol attribute name.The attribute names in FORMATs are not restricted to EUDC attribute namesbut can also be protocol/server specific names. In this case, this variablemust be set in a protocol/server-local fashion, see `eudc-server-set' and`eudc-protocol-set'.":tag"Format of Inline Expansion Queries":type'(repeat(repeat:menu-tag"Format":tag"Format"(choice:tag"Attribute"(const:menu-tag"First Name":tag"First Name"firstname)(const:menu-tag"Surname":tag"Surname"name)(const:menu-tag"Email Address":tag"Email Address"email)(const:menu-tag"Phone":tag"Phone"phone)(symbol:menu-tag"Other":tag"Attribute name")))):group'eudc)(defcustomeudc-expansion-overwrites-queryt"*If non nil, expanding a query overwrites the query string.":type'boolean:group'eudc)(defcustomeudc-inline-expansion-format'("%s"email)"*A list specifying the format of the expansion of inline queries.This variable controls what `eudc-expand-inline' actually inserts inthe buffer. First element is a string passed to `format'. Remainingelements are symbols indicating attribute names; the corresponding valuesare passed as additional arguments to `format'.":type'(list(string:tag"Format String")(repeat:inlinet:tag"Attributes"(choice:tag"Attribute"(const:menu-tag"First Name":tag"First Name"firstname)(const:menu-tag"Surname":tag"Surname"name)(const:menu-tag"Email Address":tag"Email Address"email)(const:menu-tag"Phone":tag"Phone"phone)(symbol:menu-tag"Other")(symbol:tag"Attribute name")))):group'eudc)(defcustomeudc-multi-query-policy'server-then-hotlist"*Policy for querying multiple servers.Possible values are: `current-server': the current EUDC server. `hotlist': the servers of the hotlist in the order they appear, `server-then-hotlist': the current server and then the servers of the hotlist.":type'(choice:tag"Servers":menu-tag"Servers"(const:menu-tag"Current server"current-server)(const:menu-tag"Servers in the hotlist"hotlist)(const:menu-tag"Current server then hotlist"server-then-hotlist)):group'eudc)(defcustomeudc-max-servers-to-querynil"*Maximum number of servers to query for an inline expansion.If nil, query all servers available from `eudc-inline-expansion-servers'.":tag"Max Number of Servers to Query":type'(choice:tag"Max. Servers":menu-tag"Max. Servers"(const:menu-tag"No limit"nil)(const:menu-tag"1"1)(const:menu-tag"2"2)(const:menu-tag"3"3)(const:menu-tag"4"4)(const:menu-tag"5"5)(integer:menu-tag"Set")):group'eudc)(defcustomeudc-query-form-attributes'(namefirstnameemailphone)"*A list of attributes presented in the query form.":tag"Attributes in Query Forms":type'(repeat(choice:tag"Attribute"(const:menu-tag"First Name":tag"First Name"firstname)(const:menu-tag"Surname":tag"Surname"name)(const:menu-tag"Email Address":tag"Email Address"email)(const:menu-tag"Phone":tag"Phone"phone)(symbol:menu-tag"Other":tag"Attribute name"))):group'eudc)(defcustomeudc-user-attribute-names-alist'((url."URL")(callsign."HAM Call Sign")(id."ID")(email."E-Mail")(firstname."First Name")(cn."Full Name")(sn."Surname")(givenname."First Name")(ou."Unit")(labeledurl."URL")(postaladdress."Address")(postalcode."Postal Code")(l."Location")(c."Country")(o."Organization")(roomnumber."Office")(telephonenumber."Phone")(uniqueidentifier."ID")(objectclass."Object Class"))"*Alist of user-defined names for directory attributes.These names are used as prompt strings in query/response forms instead of the raw directory attribute names.Prompt strings for attributes that are not listed hereare derived by splitting the attribute nameat `_' characters and capitalizing the individual words.":tag"User-defined Names of Directory Attributes":type'(repeat(cons:tag"Field"(symbol:tag"Directory attribute")(string:tag"User friendly name "))):group'eudc)(defcustomeudc-use-raw-directory-namesnil"*If non-nil, use attributes names as defined in the directory.Otherwise, directory query/response forms display the user attributenames defined in `eudc-user-attribute-names-alist'.":type'boolean:group'eudc)(defcustomeudc-attribute-display-method-alistnil"*An alist specifying methods to display attribute values.Each member of the list is of the form (NAME . FUNC) where NAME is a lowercasedstring naming a directory attribute (translated according to `eudc-user-attribute-names-alist' if `eudc-use-raw-directory-names' is non-nil) and FUNC a function that will be passed the corresponding attribute values for display.":tag"Attribute Decoding Functions":type'(repeat(cons:tag"Attribute"(symbol:tag"Name")(symbol:tag"Display Function"))):group'eudc)(defcustomeudc-external-viewers'(("XV""xv""-")("ImageMagick""display""-")("ShowAudio""showaudio"))"*A list of viewer program specifications.Viewers are programs which can be piped a directory attribute value fordisplay or arbitrary processing. Each specification is a list whose first element is a string naming the viewer. The second element is the executable program which should be invoked, and following elements arearguments that should be passed to the program.":tag"External Viewer Programs":type'(repeat(list:tag"Viewer"(string:tag"Name")(string:tag"Executable program")(repeat:tag"Arguments":inlinet(string:tag"Argument")))):group'eudc)(defcustomeudc-options-file"~/.eudc-options""*A file where the `servers' hotlist is stored.":type'(file:Tag"File Name:"):group'eudc)(defcustomeudc-mode-hooknil"*Normal hook run on entry to EUDC mode.":type'(repeat(sexp:tag"Hook definition")):group'eudc);;}}};;{{{ PH Custom Group(defgroupeudc-phnil"Emacs Unified Directory Client - CCSO PH/QI Backend.":group'eudc)(defcustomeudc-ph-bbdb-conversion-alist'((name.name)(net.email)(address.(eudc-bbdbify-addressaddress"Address"))(phone.((eudc-bbdbify-phonephone"Phone")(eudc-bbdbify-phoneoffice_phone"Office Phone"))))"*A mapping from BBDB to PH/QI fields.This is a list of cons cells (BBDB-FIELD . SPEC-OR-LIST) whereBBDB-FIELD is the name of a field that must be defined in your BBDBenvironment (standard field names are `name', `company', `net', `phone',`address' and `notes'). SPEC-OR-LIST is either a single SPEC or a listof SPECs. Lists of specs are valid only for the `phone' and `address'BBDB fields. SPECs are sexps which are evaluated: a string evaluates to itself, a symbol evaluates to the symbol value. Symbols naming PH/QI fields present in the record evaluate to the value of the field in the record, a form is evaluated as a function. The argument list may contain PH/QI field names which eval to the corresponding values in the record. The form evaluation should return something appropriate for the particular BBDB-FIELD (see `bbdb-create-internal'). `eudc-bbdbify-phone' and `eudc-bbdbify-address' are provided as convenience functions to parse phones and addresses.":tag"BBDB to PH Field Name Mapping":type'(repeat(cons:tag"Field Name"(symbol:tag"BBDB Field")(sexp:tag"Conversion Spec"))):group'eudc-ph);;}}};;{{{ LDAP Custom Group(defgroupeudc-ldapnil"Emacs Unified Directory Client - LDAP Backend.":group'eudc)(defcustomeudc-ldap-bbdb-conversion-alist'((name.cn)(net.mail)(address.(eudc-bbdbify-addresspostaladdress"Address"))(phone.((eudc-bbdbify-phonetelephonenumber"Phone"))))"*A mapping from BBDB to LDAP attributes.This is a list of cons cells (BBDB-FIELD . SPEC-OR-LIST) whereBBDB-FIELD is the name of a field that must be defined in your BBDBenvironment (standard field names are `name', `company', `net', `phone',`address' and `notes'). SPEC-OR-LIST is either a single SPEC or a listof SPECs. Lists of specs are valid only for the `phone' and `address'BBDB fields. SPECs are sexps which are evaluated: a string evaluates to itself, a symbol evaluates to the symbol value. Symbols naming LDAP attributes present in the record evaluate to the value of the field in the record, a form is evaluated as a function. The argument list may contain LDAP field names which eval to the corresponding values in the record. The form evaluation should return something appropriate for the particular BBDB-FIELD (see `bbdb-create-internal'). `eudc-bbdbify-phone' and `eudc-bbdbify-address' are provided as convenience functions to parse phones and addresses.":tag"BBDB to LDAP Attribute Names Mapping":type'(repeat(cons:tag"Field Name"(symbol:tag"BBDB Field")(sexp:tag"Conversion Spec"))):group'eudc-ldap);;}}};;{{{ BBDB Custom Group(defgroupeudc-bbdbnil"Emacs Unified Directory Client - BBDB Backend.":group'eudc)(defcustomeudc-bbdb-use-locations-as-attribute-namest"If non-nil, BBDB address and phone locations are used as attribute names.This has no effect on queries (you can't search for a specific location)but influences the way records are displayed":type'boolean:group'eudc-bbdb)(defcustomeudc-bbdb-enable-substring-matchest"If non-nil, authorize substring match in the same way BBDB does.Otherwise records must match queries exactly.":type'boolean:group'eudc-bbdb);;}}}(provide'eudc-vars);;; eudc-vars.el ends here