Clean up parenthetical spacing in bin/mudpy

For better PEP-8 conformance, correct parenthetical spacing in the
bin/mudpy file.

Mark unused import false positives

Since the reload framework in the package's init imports modules
which look as if they don't get used, add noqa comments inline to
indicate they should be ignored by static analysis tools.

Convert sample data directory index to YAML

Support data directory indices in YAML

* lib/mudpy/data.py(DataFile.load_yaml,DataFile.load_mpy): Add routines
to look for a YAML file index as well as the old INI-based format. For
YAML files, don't bother recasting entries to lists or dicts since they
should already be returned as the desired type.

Convert sample prop data file to YAML

File read-only check supports YAML

* lib/mudpy/data.py(DataFile.is_writeable): Add support for determining
read-only status of YAML data files.

Convert sample area data file to YAML

Don't unnecessarily recast lists and dicts

* lib/mudpy/misc.py(Element.getlist,Element.getdict): Unlike INI, YAML
directly encodes other datatypes in addition to strings. When using get
functions for lists and dicts, if they're already provided in their
desired form then don't recast them as doing so would instead create
nested datatypes instead.

Initialize data file contents on creation

* lib/mudpy/data.py(DataFile.__init__): When instantiating a DataFile,
initialize its data class variable as an empty dict in case it's
traversed before getting populated.

Convert menu data file to YAML

Catch exceptions in YAML menus

* lib/mudpy/misc.py(Element.facets,Element.get): Early in login and
account creation, elements can have None in place of a dict for their
data. Under these circumstances, listing their keys throws
AttributeError and deep-linking into specific keys throws TypeError.
Catch these and treat them as empty.

Convert command data file to YAML

Convert archetype data file to YAML

Begin the transition from INI to YAML

* lib/mudpy/data.py(DataFile.load): Temporarily turn this method into a
selector which calls different loader methods depending on the file
extension so that old INI and new YAML files can be intermixed during
the transition.
(DataFile.load_yaml): This new loader method handles YAML files.
(DataFile.load_mpy): This is basically the old DataFile.load method.
(DataFile.save,DataFile.is_writeable): Add some TODO reminders for the
YAML transition.

* lib/mudpy/misc.py(Element.__init__,Element.facets,Element.get)
(Element.getboolean): Add conditional branching around calls deeper into
mudpy.data which need different behavior depending on the underlying
file formats.

* requirements.txt: Start tracking Python module dependencies in this
new file, and add the pyyaml module as the first entry.

Correct stray use of location

Clean up rendering in coder documentation

* doc/coder.txt: Correct top-level numbering prefix and several
syntactically incorrect references.

Use area instead of location or room

Since the term "location" was already used for the name of the facet
identifying the area where an element is located, it was vague to also
use that term for a class of elements which serve as those locations.
Instead use the term "area" since it's as descriptive and shorter. Also
avoid the term "room" as a synonym since areas can be outside as well as
indoors. This further implies renaming the location.mpy sample file to
become area.mpy instead.

Simplify coder documentation

* doc/coder.txt: Stop suggesting that tarballs and epydoc documentation
are updated for every commit, since currently they aren't. Gut the style
guide now that the project is fully PEP-8 compliant, and suggest a
couple of code checking utilities to help keep it clean.

Make exception logging failures more robust

* lib/mudpy/misc.py(excepthook): When an uncaught exception is raised
and the attempt to log it fails, try to write it to stdout directly and
also mention the new exception details.

Be explicit when show result raises an exception

* lib/mudpy/misc.py(command_show): If an admin uses the show result
command and it raises an exception, return the details in the result
message.

Tighten exceptions for new sockets and reads

* lib/mudpy/misc.py(User.enqueue_input,check_for_connection): When
reading from a socket or polling for a new connection, be specific about
the exceptions which are benign so that we will still error out when
more detrimental exceptions are raised.

Fix log spamming on premature socket disconnect

* lib/mudpy/misc.py(User.flush): When sending on a user's socket raises
BrokenPipeError, their connection has probably dropped. Go ahead and set
their state to disconnecting so the socket will be cleaned up earily.
This also stops spamming the log on every failed write to a broken
socket before it eventually times out in the TCP/IP stack as well.

Stop trying to rename the daemon process

* lib/mudpy/misc.py(daemonize): Remove the hacky process table entry
rewriting routines. They weren't cross-platform and never really worked
well. Also, these days admins are more used to daemons in interpreted
languages and know how to spot them in a process list with relative
ease.

Wrap long lines without using backslashes

Try to align more closely with Python style guidelines on wrapping long
lines.

Clean up docstrings

Fix reload to use a copy of datafile keys

* lib/mudpy/misc.py: Python 2.x was more tolerant of this and it now
breaks under 3.4 release candidates, but correcting it to iterate over a
copy is arguably more correct anyway.

Remove unused event code

* lib/mudpy/misc.py: Event elements weren't fully implemented, so rip
out the dead code in preparation for a different implementation.

Correct copyright date for changelog

Drop support for Python 2.x

Remove all derecated conditionals and fallbacks which provided
workarounds for supporting Python 2.x versions.

Clean up imports

Group all imports at the tops of files and alphabetize, for ease of
maintainabiity.

Fix an incorrect TODO comment line

Recast to unicode when normalizing on Python 2.x

* lib/mudpy/misc.py: Explicitly recast text to unicode type when passing
to unicodedata.normalize on Python 2.x.

Byte type comparisons on the output queue

* lib/mudpy/misc.py: When comparing against data already in the output
queue, use byte type for compatibility with Py3K.

Import a correct configparser for the interpreter

* lib/mudpy/data.py: Now import configparser and fall back to
ConfigParser if it's not found, for Py3K compatibility.

Correct byte types and encoding in test script

* bin/test: It is sufficient to encode lookahead and written values on
the Telnet socket into UTF-8, and works correctly with Py3K now.

Use chr instead of unichr

* lib/mudpy/misc.py: Missed in the earlier unicode to str patches, use
the chr function instead of unichr for Py3K compatibility.

Use bytes in process table manipulation

* lib/mudpy/misc.py: When manipulating the process table, do so using
bytes type for Py3K compatibility.

Use byte type for passwords hash encoding

* lib/mudpy/password.py: Raw hash values are manipulated as bytes for
Py3K compatibility.

Handle byte type on sockets

* bin/test
* lib/mudpy/misc.py
* lib/mudpy/telnet.py: For Py3K compatibility, socket I/O uses byte type
instead of str.

Use new 0o notation for octal constants

* lib/mudpy/data.py: For Py3K compatibility, only refer to literal octal
constants using the 0o prefix.

The reload function is in the imp module

* bin/mudpy
* lib/mudpy/__init__.py: For Py3K compatibility, only invoke the reload
function from the imp module rather than the global built-in namespace.

Use int type instead of long

* lib/mudpy/misc.py: Use int type instead of long, since Py3K will no
longer have a different representation for the latter.

Correct copyright years for change log

Recast filters when comparing

* lib/mudpy/misc.py: For Py3K compatibility, filters will need to be
recast to comparable data types when used in comparisons.

Work around lack of dict_keys index in catch-all

* lib/mudpy/misc.py: In Python 3000, dict.keys() returns a dict_keys
type which is not indexed, so work around it by converting to a list
anywhere we attempt to sort keys or access a key by ordered index.

Work around lack of dict_keys index in data loader

* lib/mudpy/data.py: In Python 3000, dict.keys() returns a dict_keys
type which is not indexed, so work around it by converting to a list
anywhere we attempt to access a key by ordered index.

Use range instead of xrange

* lib/mudpy/password.py: Python 3000 is deprecating xrange in favor of
an iterator-based range which will be effectively as efficient, so stop
using xrange in preparation for the transition.

Use absolute imports in telnet service module

* lib/mudpy/telnet.py: Absolute imports are more readable and easier to
debug, so use them.

Use absolute imports in catch-all module

* lib/mudpy/misc.py: Absolute imports are more readable and easier to
debug, so use them.

Use absolute imports in data handler module

* lib/mudpy/data.py: Absolute imports are more readable and easier to
debug, so use them.

Use absolute imports in package init module

* lib/mudpy/__init__.py: Absolute imports are more readable and easier
to debug, so use them.

Use strings not unicode in telnet service module

* lib/mudpy/telnet.py: Python 3000 treats strings as unicode by default,
so we should too.

Use strings not unicode in password module

* lib/mudpy/password.py: Python 3000 treats strings as unicode by default,
so we should too.

Use strings not unicode in catch-all module

* lib/mudpy/misc.py: Python 3000 treats strings as unicode by default,
so we should too.

Use strings not unicode in data handler module

* lib/mudpy/data.py: Python 3000 treats strings as unicode by default,
so we should too.

Use strings not unicode in package init module

* lib/mudpy/__init__.py: Python 3000 treats strings as unicode by
default, so we should too.

Use strings not unicode in functional test script

* bin/test: Python 3000 treats strings as unicode by default, so we
should too.

Use strings not unicode in daemon executable

* bin/mudpy: Python 3000 treats strings as unicode by default, so we
should too.

Use strings not unicode in changelog generator

* bin/git2gch: Python 3000 treats strings as unicode by default, so we
should too.

Additional style cleanup

* lib/mudpy/__init__.py
* lib/mudpy/data.py
* lib/mudpy/misc.py
* lib/mudpy/telnet.py: Limit lines to <80 characters and adjust
hanging/visual indents for clarity and consistency.

PEP 8 conformance for package init library

* lib/mudpy/__init__.py: Conform to the PEP 8 style guide.

PEP 8 conformance for monolithic library

* lib/mudpy/misc.py: Conform to the PEP 8 style guide.

PEP 8 conformance for password management library

* lib/mudpy/password.py: Conform to the PEP 8 style guide.

PEP 8 conformance for telnet server library

* lib/mudpy/telnet.py: Conform to the PEP 8 style guide.

PEP 8 conformance for data handling library

* lib/mudpy/data.py: Conform to the PEP 8 style guide.

PEP 8 conformance for daemon executable script

* bin/mudpy: Conform to the PEP 8 style guide.

PEP 8 conformance for ChangeLog writer script

* bin/git2gch: Conform to the PEP 8 style guide.

PEP 8 conformance for test script

* bin/test: Conform to the PEP 8 style guide.

Back end data storage separation.

* lib/mudpy/__init__.py (modules): Added the new data module to the
list.

* lib/mudpy/data.py: Implemented a new module to contain back end
data storage and retrieval functions, preparing to merge work on the
new data handling routines.

* lib/mudpy/misc.py (DataFile, find_file, makedict, makelist): Moved
to lib/mudpy/data.py.
(Element.__init__, Element.getdict, Element.getlist, Universe.load)
(replace_macros): Updated references to relocated classes and
functions.

Inline literals are more readable in source form.

* doc/coder.txt: Adjusted sections referencing literal backslashes
to use inline literal syntax rather than double-backslash syntax,
for improved clarity.

ASCII Scrub

* doc/coder.txt: Found and replaced a non-ASCII UTF-8 apostrophe.

Correcting docstring format.

* lib/mudpy/password.py (create): Corrected docstring format so that
epydoc -v will run clean of errors again.

Correcting minor docstring typos.

* lib/mudpy/password.py (create): Corrected two minor typographical
errors in the function's docstring.

Secure, extensible, forward-compatable passwords.

* lib/mudpy/__init__.py (modules): Added the new password module to
the list.

* lib/mudpy/misc.py (handler_checking_password)
(handler_entering_new_password, handler_verifying_new_password):
Replaced existing md5 usage with calls to the new password
functions.

* lib/mudpy/password.py: Implemented a new module to handle creating
and verifying account password hashes. The functions and format are
forward-compatable to new hashing algorithms, and can be scaled to
allow tuning for CPU utilization/brute-force mitigation trade-offs.
The new functions are not directly backward-compatable with the old
format, but a utility function (upgrade_legacy_hash) is included to
upgrade those hexdigests if needed.

Reformatted README for 72 columns.

* README: Switched from 79 columns to 72 columns in accordance with
the style guide in the doc/coder.txt coder guide.

Change README for new on-line documentation link.

* README: Updated the URL for the on-line documentation reference
and reworded the last sentence for clarity.

New coder guide document.

* doc/coder.txt: New document focused on topics of interest to
anyone wishing to modify the mudpy engine or get involved with the
project's development process.

Script to generate ChangeLog file from commit log.

* bin/git2gch: New executable script for generating GNU-format
ChangeLog files from the Git commit log.

Regression testing script.

* bin/test: New executable script for regression testing against all
future commits to the mudpy core engine, modules and sample data.

Cosmetic adjustment to disconnect message.

* share/menu.mpy (menu:disconnecting): Appended a newline to
separate the disconnect message from any lines which the client
might add thereafter, and switched from description to prompt.

Proper RFC 1143 Telnet option negotiation queue.

* lib/mudpy/__init__.py: Added telnet to the modules list.

* lib/mudpy/misc.py (Element.send, User.__init__)
(User.adjust_echoing, User.enqueue_input, User.flush)
(User.replace_old_connections, User.send, check_for_connection)
(get_echo_sequence, handle_user_input): Minor adjustments to
accomodate new code in telnet.py.
(User.negotiate_telnet_options, telnet_proto): Moved to telnet.py
and reworked option negotiation stack to eliminate a possible loop,
bringing the code fully in compliance with the "Q" method described
in IETF RFC 1143.

* lib/mudpy/telnet.py: New file for constants and functions related
to support of the Telnet protocol.

Clarification in README file.

* README: Adjusted indentention for the copyright metadata block and
added references to additional available documentation.

New top-level README file.

* README: New file containing basic information on the project along
with pointers to additional documentation.

Reformat license.

* doc/LICENSE: Added a brief summary and reformatted for aesthetics.

Annual copyright update.

* (all): Updated copyright notices for 2010.

Imported from archive.

* LICENSE: Moved to doc subdirectory, indicating it's a
documentation file.

* archetype, command, menu: Moved to share subdirectory, indicating
it's generally read-only data. Also appended .mpy extention to file
names, to indicate they're mudpy data.

* banner.txt, login.txt, mudpy.conf: Moved to etc subdirectory,
indicating they're generally hand-edited configuration data.

* lib/mudpy/__init__.py: Created a new Python module package, to
begin the process of splitting up the old monolithic module.

* mudpy: Moved to bin subdirectory, indicating it's directly
executable.

* mudpy.conf (__control__, internal:storage), mudpy.py
(DataFile.load, find_file, replace_macros): New functionality allows
arbitrary location of data files from relative or absolute paths out
of a prioritized series of potential directory trees.

* mudpy.conf (internal:network): Changed host to the IPv6 localhost
address of ::1 instead of the old IPv4 127.0.0.1 equivalent.

* mudpy.py: Renamed to misc.py and added to the new lib/mudpy Python
module package.
(Universe.initialize_server_socket): If local IPv6 support is
present default to listening on ::, otherwise fall back to 0.0.0.0
like before.
(command_say): Instead of denying parameters which look like
replacement macros, they are simply escaped before being processed.
Messages enclosed in quotation marks no longer get language fix-ups
applied. Fixed a bug where a type exception could be triggered if an
actor provided parameters to the say command which evaluated to an
empty string; reported by Mark Kolloros, a.k.a. Colourful.

* sample/index: Renamed to __init__.mpy in an effort to emulate
Python module package structure for groups of mudpy data files.

* sample/location, sample/prop: Appended .mpy extention to file
names, to indicate they're mudpy data.

Imported from archive.

* mudpy: Changed shebang line to invoke the interpreter through
/usr/bin/env instead of directly.

* mudpy, mudpy.py (daemonize): Rename the process to the same as the
script's file name, and add some additional descriptive comments.

Imported from archive.

* (all): Updated copyright notices for 2009.

* mudpy, mudpy.py: Changed all Python module references to be
explicit rather than importing their contents into the local
namespace, and moved all the import statements into the objects
requiring them. Made all code Unicode clean, UTF-8 encoded, and
marked relevant byte-oriented code in preparation for later Python
2to3 migration. Wrapped all code at 79 columns and changed to
three-space/non-tab indents with K&R-style bracketing. Moved more
code from the mudpy executable into mudpy.py instead.

* mudpy.py (User.flush): Added some verbose logging when an
exception is raised sending to a socket.
(User.negotiate_telnet_options): Reworked the Telnet stack into an
RFC 1143 option negotiation queue. Implemented support for binary
mode input and output RFC 856 and made the UTF-8 decoding and
encoding/substitution dependent on it. Implemented support for
negotiate about windows size RFC 1073 and changed the word-wrapping
routines to use the client's terminal width if available.
(glyph_columns, wrap_ansi_text): Improved word-wrapping to support
East Asian Width characters, which occupy two columns instead of
just one.

* example, sample: Replaced Example data with more generic sample
data.

Imported from archive.

* (all): Updated copyright notices for 2008, and added references to
the included LICENSE file. Added similar copyright notices to all
data/document files.

* LICENSE: Switched the project from modified 2-clause BSD license
to the simpler and equivalent ISC license.

* banner.txt, login.txt, menu (menu:entering_account_name)
(menu:main_utility): Implemented text file inclusion using a file
replacement macro, and relocated the ASCII/ANSI art from the
login/lobby menu descriptions into separate login.txt and banner.txt
files.

* command (command:show): Renamed parameter to option in the help.

* menu (menu:delete_avatar): Corrected a misleading typo in the
desription.

* mudpy.conf (internal:time), mudpy.py (User.__init__)
(User.check_idle, User.pulse, handle_user_input): Added idle and
linkdead dict facets, indicating how long users can idle in various
states before they're warned and ultimately disconnected.

* mudpy.py (replace_macros): Performance enhancement, moving
unnecessary declarations outside the processing loop.
(wrap_ansi_text): Refactored the word-wrapping routines to solve a
bug where lines explicitly terminated at the wrap column got wrapped
early.

Imported from archive.

* mudpy.py (User.replace_old_connections): Bug fix to make sure
old_user.account actually exists during socket replacement, and is
not merely a dangling reference.

Imported from archive.

* LICENSE, mudpy, mudpy.py: Altered the copyright statements to
correctly mention all years instead of only the most recent.

* command (command:chat, command:say), mydpy.py (User.send)
(command_chat, first_word, handler_active): Added a chat command
which toggles the avatar in and out of a mode where all further
lines of input are passed as parameters to the say command.

* command (command:quit): Minor clarifications to several command
help texts.

* command (command:say), mudpy.conf (internal:language), mudpy.py
(command_say): Moved the capitalize_words list facet to a more
flexible typos dict, and condensed punctuation_* facets into an
actions dict facet.

* mudpy.py (User.deactivate_avatar): Fixed a bug where avatars
without a location could trigger an exception.
(command_help): Added a see_also list facet for menu elements, which
allow help output to suggest other related commands.
(create_pidfile, remove_pidfile): Minor adjustments to assure file
path canonicalization.
(get_loglines): Aesthetic tweaks to the show log output.
(on_pulse): Create internal:counters if it doesn't exist, to avoid
throwing an exception.

Imported from archive.

* command (command:move): Minor cosmetic fix for the move command
help text.

* mudpy.py (User.replace_old_connections): Fixed a crash in
connection replacement detection where stale sockets without an
associated account would trigger an exception.

Imported from archive.

* mudpy.py (User.send): Reduced the word-wrap column count from 80
to 79, to deal with some clients which will themselves wrap at,
rather than after, the last column.

Imported from archive.

* mudpy.py (check_time): Removed unused function.

Imported from archive.

* command (command:reload), mudpy.py (DataFile.load, DataFile.save):
More work on data file reloading

* mudpy, mudpy.py (Universe.new): Moved more code out of the mudpy
executable into the mudpy.py Python module.
(Universe.__init__, command_halt, command_reload): Renamed the
reload_modules and terminate_world bools to reload_flag and
terminate_flag respectively.

* mudpy.conf (internal:limits), mudpy.py (DataFile.save):
Implemented a data file rotation/backup scheme, configurable through
the default_backup_count int facet.

* mudpy.conf (internal:network): Example recommended config binds
only to 127.0.0.1 initially, for added security.

* mudpy.py (daemonize): More work on daemonization.

Imported from archive.

* LICENSE, mudpy, mudpy.py: Updated copyright notices for 2006.

* mudpy, mudpy.conf (internal:process), mudpy.py (create_pidfile)
(daemonize, remove_pidfile): Implemented optional
fork-and-disassociate daemon capability.

* mudpy.conf (internal:network), mudpy.py
(Universe.initialize_server_socket): Now, if the host facet is
unset, it defaults to 0.0.0.0 (listen on all available IP
interfaces).

* mudpy.py (Element.clean_contents, Element.reload)
(Element.update_location, Universe.load, reload_data): Additional
Element methods to clean up data file reloading.
(sighook): Added a signal handler to interpret hangup as if an admin
had executed the reload command, and term as if the halt command had
been issued.

Imported from archive.

* command (command:show), mudpy.py (command_show): Improved
parameter descriptions in the help text for the administrative show
command, and added a file parameter to allow listing of elements
included within a known data file.

* command (command:show), mudpy.py (command_show, get_loglines):
Modified the administrative show log command to take parameters for
filtering and start/stop entry ranges.

* mudpy.py (DataFile.load, Universe.load, command_reload)
(reload_data): The administrative reload command now re-reads data
from read-only data files and updates the corresponding elements.
(command_show): Refactored if/then spaghetti logic to be easier to
follow.

Imported from archive.

* mudpy.py (Element.can_run, User.can_run): Moved this method from
the User class to the Element class, allowing for future
flexibility.
(Element.new_event, Universe.get_time): Began adding framework for
event elements and queues.
(command_create, command_delete, command_destroy, command_error)
(command_halt, command_help, command_look, command_move)
(command_quit, command_reload, command_say, command_set)
(command_show): Adjusted commands and messaging to be relative to an
actor element instead of a user object.

Imported from archive.

* archetype, mudpy.conf (__control), mudpy.py (User.new_avatar),
template: Retermed template as archetype.

* mudpy.py: Added more code commentary, and refactored some sections
of the source to improve readability.
(DataFile.is_writeable, DataFile.save): Abstracted out the writeable
check from the save method into a separate method.
(DataFile.save): Adjusted to only write when elements within that
file have been modified.
(Element.delete): Removed obsolete method, recently implemented more
cleanly as remove_facet.

Imported from archive.

* command (command:show), mudpy.py (command_show): Added a log
parameter to the admin command show, allowing administrative users
to review recent log entries.

* mudpy.conf (internal:logging), mudpy.py (log): Added an in-memory
ring buffer for logging, configurable via the max_log_lines facet.

* mudpy.py (excepthook): Attempt to log any Python interpreter
exceptions.
(log): Implemented a log priority mechanism to allow filtering logs
by importance. Log entries above an administrative account's
loglevel int facet in will be echoed to their owner's socket if
connected.