View on
MetaCPAN
Nicolas Chuche > RTx-EmailCompletion-0.06 > RTx::EmailCompletion

Download:
RTx-EmailCompletion-0.06.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  4
Open  5
Stalled  1
View/Report Bugs
Module Version: 0.06   Source  

NAME ^

RTx::EmailCompletion - Add auto completion on RT email fields

VERSION ^

This document describes version 0.06 of RTx::EmailCompletion.

DESCRIPTION ^

I'm so tired to type email address by hand that I've done this module to add AJAX autocompletion on all email field of RT. As adding completion is dynamic, it should work on most RT releases (see later if it's not the case).

There's 4 things :

INSTALLATION ^

if upgrading from a previous release see later UPGRADE FROM PREVIOUS RELEASE

if you upgrade from a version older than 0.05 of this module with RT >= 3.8, see later SCRIPTACULOUS AND RT 3.8

Install it like a standard perl module :

 RTHOME=/opt/rt3 perl Makefile.PL
 make
 make install

CONFIGURATION ^

In RT 3.8 and later, to enable EmailCompletion plugin, you must add something like that in your etc/RT_SiteConfig.pm :

    Set(@Plugins,(qw(RTx::EmailCompletion)));

This section is fairly long but you don't really need to read it if you just want the basic : autocompletion only for privileged users against all registred users of RT database.

unprivileged users autocompletion

By default, completion works only for privileged users.

You can activate it for unprivileged users (in the SelfService) by setting $EmailCompletionUnprivileged in RTHOME/etc/RT_SiteConfig.pm. There's three ways :

change the database clause to search email

You can also change the operator used in the where clause to search email with the global var $RT::EmailCompletionSearch. The default one is LIKE.

To change it, add a line like this in RTHOME/etc/RT_SiteConfig.pm :

 Set($EmailCompletionSearch, "STARTSWITH");

This variable can take the values LIKE, STARTSWITH and ENDSWITH.

By default, the plugin searches on Users.EmailAddress.

You can change where it searches by setting $EmailCompletionSearchFields in RTHOME/etc/RT_SiteConfig.pm to an arrayref of fields from the Users table.

   Set( $EmailCompletionSearchFields, [qw(EmailAddress RealName Name)] );

This would allow you to search by usernames, full names and email addresses

LDAP configuration

Starting with RTx::EmailCompletion 0.03, autocompletion works with LDAP servers.

If you already have installed and configured LDAP authentication overlay, this configuration will be used and it should/could work just as it is.

The following configuration parameters applied :

The minimum LDAP configuration look somethink like this :

  Set($EmailCompletionLdapServer, "db.debian.org");
  Set($EmailCompletionLdapBase, "dc=debian,dc=org");

You can disable ldap completion (useful if you have installed ldap authentication overlay and you don't want ldap completion) with :

  Set($EmailCompletionLdapDisabled, 1);

If you want to keep only LDAP completion, you can also disable RDBMS :

  Set($EmailCompletionRdbmsDisabled, 1);

The given value must be true for perl.

HOW TO ADD FIELD TO AUTOCOMPLETION ^

If you find email field without autocomplete, you can modify html/NoAuth/js/emailcompletion.js to handle this field (and email me to patch this module).

At the beginning of this file you will find two global vars multipleCompletion and singleCompletion. They are array of regexp.

Regexp must match all the word because ^ and $ are added for matching. So if you want to match Field1 and Field2 you must add something like Field. or better Field[12].

To verify that javascript find your input tag, you can uncomment the line just after the "DEBUGGING PURPOSE" one. All input tags find by the script will appear with a big red border.

UPGRADE FROM PREVIOUS RELEASE ^

Because of a change in Makefile.PL, if you upgrade from a previous release, you should delete everything from this package. You can find

  find RTHOME | grep -i emailcompletion

SCRIPTACULOUS AND RT 3.8 ^

RT 3.8 and later come with their own scriptaculous library. So if you have installed an release older than 0.05 of this module with RT 3.8 and later, the original scriptaculous will be overriden by this module.

The best solution is to remove RTHOME/share/html/NoAuth/js/ and copy RTSOURCE/share/html/NoAuth/js/ to RTHOME/share/html/NoAuth/.

This release is not subject to this problem.

HISTORY ^

The first version (unreleased) modify html pages. The better method actually used allow this module to be compatible with, virtually, all RT release.

AUTHORS ^

Nicolas Chuche <nchuche@barna.be>

COPYRIGHT ^

Copyright 2007 by Nicolas Chuche <nchuche@barna.be>

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

See http://www.perl.com/perl/misc/Artistic.html

All Scriptaculous and Prototype program are placed under MIT licence and are copyrighted by their owners (see top of files).

syntax highlighting: