Revisions for imp/lib/Filter.php

More merges from my private dev branch.

IMP_MailboxCache -> IMP_MessageCache.

Tags: IMP_4_3, IMP_4_3_RC2, IMP_4_2_1_RC1, IMP_4_2, IMP_4_2_RC4, IMP_4_2_RC3

This has bothered me for the longest time - we are storing messages in this
cache, not mailboxes.  Change the library name now and corresponding config
options so we don't need to change them after 4.2 is released.

Bug: 5234
MFH: Add hook for adding formatting information to a message list row.

Tags: IMP_4_2_RC2

Happy New Year

Happy New Year

Bug: 5234
Merge after: 3 days
Add hook for adding formatting information to a message list row.

Merge from HEAD.

Have blacklistMessage() return if it was successful in deleting.

Tags: BEFORE_MERGE_3_2, IMP_4_2_RC1, IMP_4_2_ALPHA

Make link in notification message optional.

Bug: 5054
MFH: CHANGES - 1.1016; Filter.php - 1.74

Tags: IMP_4_1_6, IMP_4_1_5, IMP_4_1_4

Bug: 5054
Pass R/W stream to filters API.

Bug: 4569
Automatically delete blacklisted messages.

Happy New Year

Tags: IMP_4_1_4_RC1

Happy New Year

Assign copyright to The Horde Project for those copyright holders that already agreed to it.

Various minor tweaks.

Remove 'stream' as a session variable.  it is nothing more than a disguised
global since it doesn't persist between page accesses.
Don't require us to pass the imap stream to several overriden functions since
we can do the necessary stream passing in the overriden functions themselves.

IMP_Filter:: doesn't need a singleton().

standardize my e-mail address

MFH 1.66

Tags: IMP_4_1_3, IMP_4_1_2, IMP_4_1_1, IMP_4_1, IMP_4_1_RC3

fix phpdoc

MFH: Convert IMP_Filter:: to OO access.
IMP_Filter::filter() now supports search folders.

Convert IMP_Filter:: to OO access.
IMP_Filter::filter() now supports search folders.

Happy new year

Tags: IMP_4_1_RC2, IMP_4_1_RC1

Happy new year\!

use the cached IMP_Headers:: object.

Merged from HEAD

MFH: Remove unneeded "@access public".
Wrapping.

Tags: IMP_4_0_5, IMP_4_0_4, IMP_4_0_4_RC2, IMP_4_0_4_RC1

Remove unneeded "@access public".
Wrapping.

Tags: BEFORE_MERGE_3_1

MFH 1.61

Tags: IMP_4_0_3, IMP_4_0_3_RC1

No reason to pass these arrays by reference.

MFH: IMP.php - 1.462; Message.php - 1.166; Spam.php - 1.5;
mailbox.php - 2.625, 2.626; message.php - 2.568; Filter.php - 1.60;
CHANGES - 1.764

Fix whitelist/blacklist additions from a search mailbox screen.

MFH 1.59

Registry::link() doesn't run URLs through Horde::url(), so we need to do this
here to attach session IDs if necessary.

Bug: 1417

Bug: 1162
Don't output success messages here - we need to do this in ingo instead.

Happy New Year

Happy New Year

Tags: IMP_4_0_2, IMP_4_0_2_RC1, IMP_4_0_1

Don't automatically redirect to black/whitelist page.  Provide link instead.

Tags: FRAMEWORK_3, IMP_4_0, IMP_4_0_RC3, IMP_4_0_RC2, IMP_4_0_RC1, IMP_4_0_BETA

Fix package names.

Happy new year everyone.

Tags: IMP_4_0_ALPHA

Move classes that extend Horde libraries to subdirectories.

Allow filtering on any mailbox if the backend allows on demand filtering.
Disabled by default.

Allow declination.

Don't need this parameter anymore.

IMP::serverString() can now append folder name to output.

Only provide blacklist/whitelist links if available (specifically check
lacklist availability since IMP can no provides an API interface).
Also, no need to check the show[Black|White]list method in mailbox/message -
check in IMP_Filter:: instead.

Bug:
Submitted by:
Merge after:
OK here it is - finally the removal of the actual filtering details from
the IMP code.  I wanted to get this in ASAP simply because there are many
file changes and I may not be around much later this week - thus, I wanted
to commit when I know all these files are up to date. I've been using this
code for about a week and everything I have tried looks ok.

If you haven't configured ingo yet, you should if you want to continue to
use filters as IMP used to provide them. See imp/docs/INSTALL.

If ingo isn't set up yet, this should not be a critical problem - IMP simply
won't filter any mail until it is set up.  For those that want to try
converting their IMP HEAD filters to ingo (and possibly IMP 3.x filters
although I haven't been able to test), try
ingo/scripts/convert_imp_scripts.php. YMMV.

Make sure your horde/config/registry.php is up-to-date also.

There is no longer a 'filter_on_refresh' preference - it has been replaced
by 'filter_on_display' instead.  Once you convert your filters, you no longer
need the 'filters' preference either.

IMP no longer handles filtering - instead, IMP only deals with basic
filter preferences and everything else is handled by Horde API calls.

[mms] IMAP_Search:: now uses a IMAP_Search_Query:: object to build the
actual IMAP search.
There are still optimizations that can be done in the library, but it works
and will make implementing the ingo scripts much easier.

blacklistMessage() and whitelistMessage() fit nicer in IMP_Filter:: than
IMP::.

Need to have access to $imp here.

[mms] Move complex IMAP searching code from IMP_Search:: to IMAP_Search::.
Ingo, for example, will need this functionality (very soon).

Bug: 1215
[mms] Correct display of filter rules with "special" HTML characters.

Add 'Nuke Message' action to filters.

Abstracted out searching code in IMP_Filter:: (moving it to IMP_Search::) so
that the extended header searching could be accessed anywhere, not just
inside the filtering code.  This theoretically should allow AND searches
to work, although the UI still needs to be developed.

strtoupper() -> String::upper()

Rename String::strtolower() to String::lower() and strtoupper() to upper().

This should be String, not NLS, right Jan?

Abstracted the code in IMP_Filter to allow for various filtering storage
backends.  Currently, only a prefs storage backend (the IMP default) is
available.
Some small performance enhancements to adding blacklist addresses.
array_search() only needs to be checked for false now (as of PHP 4.2.0).

Bump year.

Use NLS::strtolower() where appropriate.

Convert IMP_Folder into an OO-interface. This lets us get rid of the
static variables in various functions (yuck).

Tweaks to storage of filters.

Add upgrading documentation (at least a start).
Filter upgrade code has been moved to scripts/convert_filters.php.

Convert blacklist to a registry call, and add the methods for IMP to
handle it if another app doesn't override mail/blacklistFrom and
mail/showBlacklist.

Treat "@domain.tld" correctly as host-only blacklist.

Notify about email addresses that have been blacklisted.

style

Brainfart - when registering a shutdown function it makes a whole hell of a
lot of sense to use a _pointer_ to the object/class instead of a _copy_
of the object/class - obviously, when using a copy, it will only see changes
that took place to data up to the point of registering the shutdown
function.

Object style.

More IMP_Message->IMP_Mailbox stuff. If anyone knows a better way to have
an optional "pass by reference" parameter rather than what I have done
(simply silence the warnings with "@" e.g. "@new IMP_Message"), let me know...

Fix register_shutdown_function() activity.

Better (and fully working) conversion method.

PHP's implementation of imap_search() won't let you use 'OR'?  Are you
kidding me?  That _really_ stinks.  We have to go back to the old way -
searching *every* field with a separate imap_search() call.  ugh.
If I knew C I would fix PHP.  But I don't so I should stop whining.

IMP_Filter framework now uses a new data structure - this new structure
allows for the creation and storage of "AND" filters (although the query
code needed for this has not been implemented yet).
Blacklists are now stored separately.  This is a more efficient during loading,
allows us to search for _all_ blacklist addresses in a _single_ imap
query (instead of a separate query for each address before), and ensures that
blacklist filters will always be applied before other filters.
TODO: implement UI for adding "AND" rules; implement code to correctly
formulate "AND" queries for the IMAP server.

* Fix "OR" searches using imap_search().
* Return empty_array if $match_indices is empty (no search results).

* Private variable naming.
* Much improved logic to determine matched messages.  Each filter requires
  only a single IMAP search call (as opposed to a separate call for each
  field in a filter before).  Additionally, header information for
  "non-standard" headers are cached so that the header information does not
  need to be rebuilt for every field.

Added GPL information to lib files.  Also, phpdoc fixes in various places.

Oops.

Silence warning.

First stab at filtering by any header - any pointers on how this can be
made cleaner would be gladly appreciated (in short, we can't use the TEXT
search command since it doesn't search Header _names_; the HEADER search
command is not implemented by all IMAP servers).

Updates to the filter management page.  Now allows any header to be filtered
(even though the actual filtering code is not written yet - so DON'T expect
anything to work as of right now.)  Since there are various other display,
dos->unix CRLF, and javascript fixes, I wanted to get this commited even
without all the functionality.

We _must_ call prefs->store() here since the prefs shutdown function will
have most likely already run before we get here.

Prefs:: transparently saves all "dirty" prefs entries to our storage
backend for us now.

Don't show blacklist entries in filter rules.
Improved saving of blacklist entries.
getBlacklist() now always returns the filter index as the key.

Make sure only one shutdown function is registered.

make sure MIME.php is loaded before we use it.

moveFilter() returns boolean result.

"do" in method names is nearly always redundant.

arg order, missing $this->

Bugfixes and cleanups.

Use IMP_Filter:: for all filtering activities.

Moved more filtering stuff to IMP_Filter::.

* Added an IMP_Filter:: class.
* Use Horde::addParameter() to build URLs.
* style