Refactured nodeInstance to be no longer stored in helpers

Added encapsulation:
- Encapsulated adding of entries to the producer's out-going/incoming queue
- Encapsulated checking if the out-going/incoming queue's size has reached a
  configurable limit
- Encapsulated initialization (and forced re-init) of both queues

Some code cosmetics applied

Move this away...

The key producer may produce as twice as keys per second:
- The key producer runs now with an interval delay of 5ms
- Some debug messages/comments updated

Cruncher continued and rewritten to use states:
- States 'init' and 'virgin' introduced
- Needed cruncher parts refactured to use the new states
- Creation of node/cruncher states is now done in factories
- Key producer added which will produce keys if the required state 'virgin' is
  beging detected. This producer works without a loop which is recommended for
  task-based applications
- A lot other improvements
- TODOs.txt updated

Added all node types, moved iterator class:
- Added all types of (hub/cloud) nodes for easy coding
- Moved key producer iterator class to sub directory
- TODOs.txt updated

Methods defined in interfaces are always public...

Two methods in CruncherTestUnitProducer are now throwing UnsupportedOperationException if they got called which should not happen.

Rewritten session id solver to lesser negation

Completely replaced regex for detecting ip:port combinations

Generation of test units and keys continued:
- Database folder for crunher projects added
- Introduced two methods to MessageHelper
- Introduced an iterator for test unit producers to generate keys
- TODOs.txt updated

The encrypted message is now assigned to its template variable, big comment added for upcoming (tomorrow more) commits

Fixed a typo in field/attribute name (thanks to __get()/__set() methods)

Swapped code, moved/renamed classes and interfaces:
- Swapped code between TestUnitSource and CryptoRandomUnitMessageHelper, the
  helper is now encapsulating and the source is now a source for the helper
- Introduced generic Helper interface to existing helper interfaces (from latest
  'core' changes)
- Renamed/moved some classes/interfaces
- TODOs.txt updated

The previously added but not used message helper is now being used (and filled with 'life')

Added more classes (source for anything 'sourced', etc):
- Added some (partly unused) more classes for creating test units
- CryptoRandomMessageHelper is currently unused
- Added factory to create unit source classes
- TODOs.txt updated

Added parameter 'key' to encryption methods to allow own keys

Added a out-going work queue (FiFoStacker instance) to the test unit producer

Test units continued, XML MIME type worked-around:
- XMLs must have the MIME type "text/plain" in subversion, with
  "application/xml" they would be threated as binary files... :-(
- Template engine for cruncher test units basicly finished
- TODOs.txt updated

If the class is final, no methods can be overwritten and therefore all methods are also final

MIME types fixed

Continued on test-unit producer, fixed copyright:
- Added an unfinished template engine for the test-unit producer
- Added basic XML templates for test-unit producers
- Fixed copyright line (it was copyrighted to the Ship-Simu developer team)
- TODOs.txt updated

Required interface 'Registerable' added

Set application instance first (to prevent a NPE in BaseRegistry) and no 'this' in static environments

In 'core' introduced XmlTemplateEngineFactory used:
- Rewrite to new XmlTemplateEngineFactory (which saves code where some required
  steps could be forgotten)
- Added a method in test unit producer for initialization
- TODOs.txt updated

Removed obsolete parameter 'applicationInstance' from all template engines

Producers should always extend BaseProducer

Producer/Consumer Pattern introduced:
- Producer/Consumer interfaces added
- First producer for test units introduced
- TODOs.txt updated

Introduced a test-unit producer task (unfinished work)

Some configuration entries prefixed with 'node_'

Documentation tag fixed for method detectCorePath() (all projects)

Many XML-related templates engines renamed:
- All XML-bases template engines prefixed with 'Xml'
- Directory prepared for template engines handling WU XML templates
- TODOs.txt updated

Made two (generic/'base') classes abstract because calls are done from the generic/'base' class to a concrete class

Generator/helper class for generating test units introduced:
- There is currently a loop in the cruncher class which is not recommended but maybe fine here

A requestInstance must no longer be set in cruncher

Some methods moved around (the code is now a some-what template-method-pattern

A lot new methods/class added and many cleanups:
- Double-quotes converted to single to speed-up things a little
- Wrong BaseconnectionInstance fixed
- New methods introduced to cruncher:
  + doFetchWorkUnits(): To fetch WUs or generate test units
  + enableIsActive/isActive(): To test/set if the cruncher is active
  + initBufferQueues(): To initialize in/out buffer queues
- addExtraCruncherFilters() renamed to addExtraFilters()
- This method has now project-wide a Controller instance as first argument
- Dublicate method call to addExtraFilters() removed which happens in the
  rewriting process
- $appInstance renamed to $applicationInstance to have a better naming
  convention
- Some deprecated classes removed (they where named wrong)
- BaseHubCruncher (a generic class) extended:
  + It does now check if the in-buffer queue is filled (depending on a
    configurable threshold)
  + It implements initBufferQueues() from CruncherHelper interface
- Copyright fixed in HubMcryptCruncher
- The idle-loop task is now "genericly" registered in the TaskHandler class:
  + This implies that all task-based application will always have at least
    one (but really generic) task.
  + The method hasTasksLeft() will return 'true' in all situations unless the
    idle-loop task "kills" itself
- Generic cruncher-activation filter added
- The mentioned buffer queues are now initialized by a newly added filter class
  and handled by an own task class
- More minor code-cleanups
- TODOs.txt updated

A lot files renamed (sorry guys for the mess) and moved to sub directories

Some methods renamed

Wrong path :(

Before previous commit I was about to write only a 'test' cruncher, now this will be our real first cruncher application, more may follow, if the time is right

Copyright notice updated, our first hub application introduced (which is incomplete)
- First application 'test cruncher' for the hub (better say a cloud) introduced.
  This test cruncher shall try to find the right key for an encrypted message.
  It handles all "crunched" keys over work units like dnetc (see
  http://www.distributed.net for instance) does but instead of a central server
  it uses the "hub" as a cloud to store settings and work units in. This is, of
  course, not yet done. More on the wiki: http://wiki.ship-simu.org
- Copyright updated
- TODOs.txt updated

'public static final' is the right thing, some variables renamed to make clear what they are for

New server IP is 188.138.90.169

Properties changed

Introduced package fragmenter class to fragment network packages into smaller chunks

Properties added/fixed, externals updated (www. is out-dated)

SVN properties globally set

Now configurable static IPs are supported, Connectable rewritten, docs updated

Misleading message updated

Empty session id added to configuration, this will fix a NoConfigEntryException if there is no node data available

Support for non-regular ports added

Self-connect continued (still broken), some code moved to generic classes to encapsulate it

TODOs.txt updated

HubConnectionHelper is more a factory than a helper class, HelpableHub interface introduced

Opps... :-(

New Exception added, registering of session ids added:
- New PeerAlreadyRegisteredException added which is thrown when the peer is
  already registered with the same session id
- Registering of peers with their session id basicly added, purging unfinished

New exception and interface added, continued development:
- New InvalidSessionIdException added which will be thrown if the session id doesn't pass a preg_match() test
- TODO: That above mentioned preg_match() and the other now needs to be moved out
- New interface LookupablePeerState for "lookupable peer states" added
- Looking up session ids in database basicly added

We use these setter/getter

Fixes for lookup table class

Added peer states and lookup table classes/interfaces:
- Added new PeerStateable interface for peer states
- Added new Lookupable interface for lookup tables
- Added new PeerStateFactory class for generating peer states
- Added new PeerStateLookupTable class for looking up peer states
- Added new NewConnectionPeerState class for new peer connections

New visitor added, handling of refused connections basicly implemented:
- New ShutdownSocketVisitor added. This visitor should shutdown a socket and
  may notify other objects later on.
- Handling of refused connections (e.g. while announcement phase) basicly
  implemented. Yet there is some work left to do.

Added constants for easier usage

Added getAddressPort() method to ease comparison with 'recipient' field

Added some basic checks on received TCP packages

The packageData array should be used for handling package data

Many classes/interfaces added/continued:
- New 'tag' SocketTag added
- New classes for connection helper added
- TCP connection helper is maybe useable
- UDP connection helper is not yet finished
- New class for self connections added
- HubTools added which should provide a set of static methods
- SocketRegistry from core project added
- Continued (but maybe not-working) announcement

No more required...

A lot 'FooClientBar' classes renamed to 'FooPeerBar' for naming convention, added more missing methods for socket discovery (still incomplete/dying code)

A whole bunch of classes/interfaces/exceptions added, many refacturings:
- New classes for "tag support" added. Tags can be the "object types" this hub
  is going to share. But the purpose is kept somewhere generic so other purposes
  may come.
- A way lot interfaces updated and added (sorry for lame description)
- New factories added: (read full description way down)
  + The SocketDiscoveryFactory creates singleton instances for socket discovery
  + The PackageDiscoveryFactory does the same for package recipient discovery
  + The RecipientListFactory creates instances for recipient lists
  + The PackageTagsFactory creates singleton instances for package tags
- New class RecipientList added which can be used for tracking recipients and
  iterated on.
- New discovery classes added: ("Resolver" may also be fine naming these classes)
  + The PackageSocketDiscovery tries to "discover" the correct socket resource
    depending on the package's tags. Well, mostly this will be TCP, but UDP
    should not be forgotten... ;-)
  + The PackageRecipientDiscovery tries to "discover" the correct recipient
    based on the 'recipient' entry in the package data. May sound not obvious
    but there are some recipients which are no session id and/or IP:port
    combination. A good example is 'upper' which is an alias for all upper
    nodes like bootstrap, master and list nodes are.
- New ObjectTypeRegistry added. This registry does hold a list of all valid
  and therefore "shareable" object types in an XML. For example 'announcement'
  should only be shared with the 'upper' nodes, and only spreaded once.
- New (required for above registry) ObjectRegistryTemplateEngine added to handle
  the object_registry.xml file.
- Announcement descriptor updated
- TODOs.txt/README updated

Better handling of missing emergency_exit.ctp

Handling outgoing network packages basicly finished (but not the sending part itself)

Handling of server socket resource basic finished in BaseListener, interfaces added

New wider interface added, several refacturings:
- New interface ProtocolHandler added which should be extended by listener and
  writer interfaces. Please do not implement this interface, we only use it for
  the socket registry.
- BaseListener refactured: Handling of server socket swapped out to new
  (incomplete) socket registry.
- Callback function removed from network package to save a lot (!) memory
- New network package target 'upper' added which is an alias for all upper hubs
- deliverEnqueuedPackage() basicly finished
- Some code cosmetics applied
- TODOs.txt updated

Package class renamed, continued (sorry for lame description)
- Class NetworkPackageFactory was renamed from PackageFactory because the class
  does actually create only network package classes
- HubList class added for handling connected/disconnected classes
- Some tasks (e.g. NetworkPackageWriterTask) continued

Not thrown exceptions removed from doc-tag, TODOs added and updated

Check wether the hub is active simplified (may also improve speed)

Now the factory method is moved over to the newly introduced PackageFactory class

New factory method createPackageInstance introduced to ease creating a singleton netowork package instance

Extra new-lines removed

Network package writer added, shutdown refactured, fixes:
- New NetworkPackageWriterTask class introduced (unfinished)
- Shutdown procedure refactured to make use of the visitor pattern
- Several fixes/improvements, hub announcement still not working
- TODOs.txt updated

Removed some dublicate instances to avoid confusion

State pattern added, hub continued (sorry, I let it lay around uncommitted for long time...)

Added missing todo-builder.sh script / svn:executable removed from PHP scripts

State pattern classes for node states added, factory added, copyright updated

Non-blocking enforced and skipped handling packages from main server socket. This fixes a 'Transport endpoint is not connected' warning

For line better zero

Fixed missing file/line array elements

Hub descriptor extended, template engine added:
- New template engine AnnouncementTemplateEngine added which should parse
  hub announcement descriptors (XML)
- Hub announcement descriptor extended with listener (ports) information
- Some Missing config entries added (classes, file extensensions, etc.)
- Other minor improvements
- Copyright fixed (was 'Core', should be 'Hub')

Generic index.php is now masking backtrace data

Now the idle loop task comes first

Global fix for svn::execuetable ... :(

Global fix/add/update:
- index.php updated in all projects from ship-simu
- Missing todo-builder.sh added
- TODOs.txt updated in all projects
- Missing svn:executable added

Added a filter for checking if all requirements in PHP did meet

Added new exception, script dies:
- Added new class_HubAlreadyAnnouncedException
- Node status XML added
- Self announcement XML extended
- Script does die in HubSelfAnnouncementTask

Self-announcement rewritten to a task

publishHubDescriptor() added, TODOs.txt updated

Message added when no node list was previously found.

Fixed a missing config entry due to core updated