packages feed

hslogger4j 0.1.1 → 0.2

raw patch · 10 files changed

+15/−1701 lines, 10 filesdep −basedep −timedep ~hslogger

Dependencies removed: base, time

Dependency ranges changed: hslogger

Files

− COPYING
@@ -1,510 +0,0 @@--                  GNU LESSER GENERAL PUBLIC LICENSE-                       Version 2.1, February 1999-- Copyright (C) 1991, 1999 Free Software Foundation, Inc.-	51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA- Everyone is permitted to copy and distribute verbatim copies- of this license document, but changing it is not allowed.--[This is the first released version of the Lesser GPL.  It also counts- as the successor of the GNU Library Public License, version 2, hence- the version number 2.1.]--                            Preamble--  The licenses for most software are designed to take away your-freedom to share and change it.  By contrast, the GNU General Public-Licenses are intended to guarantee your freedom to share and change-free software--to make sure the software is free for all its users.--  This license, the Lesser General Public License, applies to some-specially designated software packages--typically libraries--of the-Free Software Foundation and other authors who decide to use it.  You-can use it too, but we suggest you first think carefully about whether-this license or the ordinary General Public License is the better-strategy to use in any particular case, based on the explanations-below.--  When we speak of free software, we are referring to freedom of use,-not price.  Our General Public Licenses are designed to make sure that-you have the freedom to distribute copies of free software (and charge-for this service if you wish); that you receive source code or can get-it if you want it; that you can change the software and use pieces of-it in new free programs; and that you are informed that you can do-these things.--  To protect your rights, we need to make restrictions that forbid-distributors to deny you these rights or to ask you to surrender these-rights.  These restrictions translate to certain responsibilities for-you if you distribute copies of the library or if you modify it.--  For example, if you distribute copies of the library, whether gratis-or for a fee, you must give the recipients all the rights that we gave-you.  You must make sure that they, too, receive or can get the source-code.  If you link other code with the library, you must provide-complete object files to the recipients, so that they can relink them-with the library after making changes to the library and recompiling-it.  And you must show them these terms so they know their rights.--  We protect your rights with a two-step method: (1) we copyright the-library, and (2) we offer you this license, which gives you legal-permission to copy, distribute and/or modify the library.--  To protect each distributor, we want to make it very clear that-there is no warranty for the free library.  Also, if the library is-modified by someone else and passed on, the recipients should know-that what they have is not the original version, so that the original-author's reputation will not be affected by problems that might be-introduced by others.--  Finally, software patents pose a constant threat to the existence of-any free program.  We wish to make sure that a company cannot-effectively restrict the users of a free program by obtaining a-restrictive license from a patent holder.  Therefore, we insist that-any patent license obtained for a version of the library must be-consistent with the full freedom of use specified in this license.--  Most GNU software, including some libraries, is covered by the-ordinary GNU General Public License.  This license, the GNU Lesser-General Public License, applies to certain designated libraries, and-is quite different from the ordinary General Public License.  We use-this license for certain libraries in order to permit linking those-libraries into non-free programs.--  When a program is linked with a library, whether statically or using-a shared library, the combination of the two is legally speaking a-combined work, a derivative of the original library.  The ordinary-General Public License therefore permits such linking only if the-entire combination fits its criteria of freedom.  The Lesser General-Public License permits more lax criteria for linking other code with-the library.--  We call this license the "Lesser" General Public License because it-does Less to protect the user's freedom than the ordinary General-Public License.  It also provides other free software developers Less-of an advantage over competing non-free programs.  These disadvantages-are the reason we use the ordinary General Public License for many-libraries.  However, the Lesser license provides advantages in certain-special circumstances.--  For example, on rare occasions, there may be a special need to-encourage the widest possible use of a certain library, so that it-becomes a de-facto standard.  To achieve this, non-free programs must-be allowed to use the library.  A more frequent case is that a free-library does the same job as widely used non-free libraries.  In this-case, there is little to gain by limiting the free library to free-software only, so we use the Lesser General Public License.--  In other cases, permission to use a particular library in non-free-programs enables a greater number of people to use a large body of-free software.  For example, permission to use the GNU C Library in-non-free programs enables many more people to use the whole GNU-operating system, as well as its variant, the GNU/Linux operating-system.--  Although the Lesser General Public License is Less protective of the-users' freedom, it does ensure that the user of a program that is-linked with the Library has the freedom and the wherewithal to run-that program using a modified version of the Library.--  The precise terms and conditions for copying, distribution and-modification follow.  Pay close attention to the difference between a-"work based on the library" and a "work that uses the library".  The-former contains code derived from the library, whereas the latter must-be combined with the library in order to run.--                  GNU LESSER GENERAL PUBLIC LICENSE-   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION--  0. This License Agreement applies to any software library or other-program which contains a notice placed by the copyright holder or-other authorized party saying it may be distributed under the terms of-this Lesser General Public License (also called "this License").-Each licensee is addressed as "you".--  A "library" means a collection of software functions and/or data-prepared so as to be conveniently linked with application programs-(which use some of those functions and data) to form executables.--  The "Library", below, refers to any such software library or work-which has been distributed under these terms.  A "work based on the-Library" means either the Library or any derivative work under-copyright law: that is to say, a work containing the Library or a-portion of it, either verbatim or with modifications and/or translated-straightforwardly into another language.  (Hereinafter, translation is-included without limitation in the term "modification".)--  "Source code" for a work means the preferred form of the work for-making modifications to it.  For a library, complete source code means-all the source code for all modules it contains, plus any associated-interface definition files, plus the scripts used to control-compilation and installation of the library.--  Activities other than copying, distribution and modification are not-covered by this License; they are outside its scope.  The act of-running a program using the Library is not restricted, and output from-such a program is covered only if its contents constitute a work based-on the Library (independent of the use of the Library in a tool for-writing it).  Whether that is true depends on what the Library does-and what the program that uses the Library does.--  1. You may copy and distribute verbatim copies of the Library's-complete source code as you receive it, in any medium, provided that-you conspicuously and appropriately publish on each copy an-appropriate copyright notice and disclaimer of warranty; keep intact-all the notices that refer to this License and to the absence of any-warranty; and distribute a copy of this License along with the-Library.--  You may charge a fee for the physical act of transferring a copy,-and you may at your option offer warranty protection in exchange for a-fee.--  2. You may modify your copy or copies of the Library or any portion-of it, thus forming a work based on the Library, and copy and-distribute such modifications or work under the terms of Section 1-above, provided that you also meet all of these conditions:--    a) The modified work must itself be a software library.--    b) You must cause the files modified to carry prominent notices-    stating that you changed the files and the date of any change.--    c) You must cause the whole of the work to be licensed at no-    charge to all third parties under the terms of this License.--    d) If a facility in the modified Library refers to a function or a-    table of data to be supplied by an application program that uses-    the facility, other than as an argument passed when the facility-    is invoked, then you must make a good faith effort to ensure that,-    in the event an application does not supply such function or-    table, the facility still operates, and performs whatever part of-    its purpose remains meaningful.--    (For example, a function in a library to compute square roots has-    a purpose that is entirely well-defined independent of the-    application.  Therefore, Subsection 2d requires that any-    application-supplied function or table used by this function must-    be optional: if the application does not supply it, the square-    root function must still compute square roots.)--These requirements apply to the modified work as a whole.  If-identifiable sections of that work are not derived from the Library,-and can be reasonably considered independent and separate works in-themselves, then this License, and its terms, do not apply to those-sections when you distribute them as separate works.  But when you-distribute the same sections as part of a whole which is a work based-on the Library, the distribution of the whole must be on the terms of-this License, whose permissions for other licensees extend to the-entire whole, and thus to each and every part regardless of who wrote-it.--Thus, it is not the intent of this section to claim rights or contest-your rights to work written entirely by you; rather, the intent is to-exercise the right to control the distribution of derivative or-collective works based on the Library.--In addition, mere aggregation of another work not based on the Library-with the Library (or with a work based on the Library) on a volume of-a storage or distribution medium does not bring the other work under-the scope of this License.--  3. You may opt to apply the terms of the ordinary GNU General Public-License instead of this License to a given copy of the Library.  To do-this, you must alter all the notices that refer to this License, so-that they refer to the ordinary GNU General Public License, version 2,-instead of to this License.  (If a newer version than version 2 of the-ordinary GNU General Public License has appeared, then you can specify-that version instead if you wish.)  Do not make any other change in-these notices.--  Once this change is made in a given copy, it is irreversible for-that copy, so the ordinary GNU General Public License applies to all-subsequent copies and derivative works made from that copy.--  This option is useful when you wish to copy part of the code of-the Library into a program that is not a library.--  4. You may copy and distribute the Library (or a portion or-derivative of it, under Section 2) in object code or executable form-under the terms of Sections 1 and 2 above provided that you accompany-it with the complete corresponding machine-readable source code, which-must be distributed under the terms of Sections 1 and 2 above on a-medium customarily used for software interchange.--  If distribution of object code is made by offering access to copy-from a designated place, then offering equivalent access to copy the-source code from the same place satisfies the requirement to-distribute the source code, even though third parties are not-compelled to copy the source along with the object code.--  5. A program that contains no derivative of any portion of the-Library, but is designed to work with the Library by being compiled or-linked with it, is called a "work that uses the Library".  Such a-work, in isolation, is not a derivative work of the Library, and-therefore falls outside the scope of this License.--  However, linking a "work that uses the Library" with the Library-creates an executable that is a derivative of the Library (because it-contains portions of the Library), rather than a "work that uses the-library".  The executable is therefore covered by this License.-Section 6 states terms for distribution of such executables.--  When a "work that uses the Library" uses material from a header file-that is part of the Library, the object code for the work may be a-derivative work of the Library even though the source code is not.-Whether this is true is especially significant if the work can be-linked without the Library, or if the work is itself a library.  The-threshold for this to be true is not precisely defined by law.--  If such an object file uses only numerical parameters, data-structure layouts and accessors, and small macros and small inline-functions (ten lines or less in length), then the use of the object-file is unrestricted, regardless of whether it is legally a derivative-work.  (Executables containing this object code plus portions of the-Library will still fall under Section 6.)--  Otherwise, if the work is a derivative of the Library, you may-distribute the object code for the work under the terms of Section 6.-Any executables containing that work also fall under Section 6,-whether or not they are linked directly with the Library itself.--  6. As an exception to the Sections above, you may also combine or-link a "work that uses the Library" with the Library to produce a-work containing portions of the Library, and distribute that work-under terms of your choice, provided that the terms permit-modification of the work for the customer's own use and reverse-engineering for debugging such modifications.--  You must give prominent notice with each copy of the work that the-Library is used in it and that the Library and its use are covered by-this License.  You must supply a copy of this License.  If the work-during execution displays copyright notices, you must include the-copyright notice for the Library among them, as well as a reference-directing the user to the copy of this License.  Also, you must do one-of these things:--    a) Accompany the work with the complete corresponding-    machine-readable source code for the Library including whatever-    changes were used in the work (which must be distributed under-    Sections 1 and 2 above); and, if the work is an executable linked-    with the Library, with the complete machine-readable "work that-    uses the Library", as object code and/or source code, so that the-    user can modify the Library and then relink to produce a modified-    executable containing the modified Library.  (It is understood-    that the user who changes the contents of definitions files in the-    Library will not necessarily be able to recompile the application-    to use the modified definitions.)--    b) Use a suitable shared library mechanism for linking with the-    Library.  A suitable mechanism is one that (1) uses at run time a-    copy of the library already present on the user's computer system,-    rather than copying library functions into the executable, and (2)-    will operate properly with a modified version of the library, if-    the user installs one, as long as the modified version is-    interface-compatible with the version that the work was made with.--    c) Accompany the work with a written offer, valid for at least-    three years, to give the same user the materials specified in-    Subsection 6a, above, for a charge no more than the cost of-    performing this distribution.--    d) If distribution of the work is made by offering access to copy-    from a designated place, offer equivalent access to copy the above-    specified materials from the same place.--    e) Verify that the user has already received a copy of these-    materials or that you have already sent this user a copy.--  For an executable, the required form of the "work that uses the-Library" must include any data and utility programs needed for-reproducing the executable from it.  However, as a special exception,-the materials to be distributed need not include anything that is-normally distributed (in either source or binary form) with the major-components (compiler, kernel, and so on) of the operating system on-which the executable runs, unless that component itself accompanies-the executable.--  It may happen that this requirement contradicts the license-restrictions of other proprietary libraries that do not normally-accompany the operating system.  Such a contradiction means you cannot-use both them and the Library together in an executable that you-distribute.--  7. You may place library facilities that are a work based on the-Library side-by-side in a single library together with other library-facilities not covered by this License, and distribute such a combined-library, provided that the separate distribution of the work based on-the Library and of the other library facilities is otherwise-permitted, and provided that you do these two things:--    a) Accompany the combined library with a copy of the same work-    based on the Library, uncombined with any other library-    facilities.  This must be distributed under the terms of the-    Sections above.--    b) Give prominent notice with the combined library of the fact-    that part of it is a work based on the Library, and explaining-    where to find the accompanying uncombined form of the same work.--  8. You may not copy, modify, sublicense, link with, or distribute-the Library except as expressly provided under this License.  Any-attempt otherwise to copy, modify, sublicense, link with, or-distribute the Library is void, and will automatically terminate your-rights under this License.  However, parties who have received copies,-or rights, from you under this License will not have their licenses-terminated so long as such parties remain in full compliance.--  9. You are not required to accept this License, since you have not-signed it.  However, nothing else grants you permission to modify or-distribute the Library or its derivative works.  These actions are-prohibited by law if you do not accept this License.  Therefore, by-modifying or distributing the Library (or any work based on the-Library), you indicate your acceptance of this License to do so, and-all its terms and conditions for copying, distributing or modifying-the Library or works based on it.--  10. Each time you redistribute the Library (or any work based on the-Library), the recipient automatically receives a license from the-original licensor to copy, distribute, link with or modify the Library-subject to these terms and conditions.  You may not impose any further-restrictions on the recipients' exercise of the rights granted herein.-You are not responsible for enforcing compliance by third parties with-this License.--  11. If, as a consequence of a court judgment or allegation of patent-infringement or for any other reason (not limited to patent issues),-conditions are imposed on you (whether by court order, agreement or-otherwise) that contradict the conditions of this License, they do not-excuse you from the conditions of this License.  If you cannot-distribute so as to satisfy simultaneously your obligations under this-License and any other pertinent obligations, then as a consequence you-may not distribute the Library at all.  For example, if a patent-license would not permit royalty-free redistribution of the Library by-all those who receive copies directly or indirectly through you, then-the only way you could satisfy both it and this License would be to-refrain entirely from distribution of the Library.--If any portion of this section is held invalid or unenforceable under-any particular circumstance, the balance of the section is intended to-apply, and the section as a whole is intended to apply in other-circumstances.--It is not the purpose of this section to induce you to infringe any-patents or other property right claims or to contest validity of any-such claims; this section has the sole purpose of protecting the-integrity of the free software distribution system which is-implemented by public license practices.  Many people have made-generous contributions to the wide range of software distributed-through that system in reliance on consistent application of that-system; it is up to the author/donor to decide if he or she is willing-to distribute software through any other system and a licensee cannot-impose that choice.--This section is intended to make thoroughly clear what is believed to-be a consequence of the rest of this License.--  12. If the distribution and/or use of the Library is restricted in-certain countries either by patents or by copyrighted interfaces, the-original copyright holder who places the Library under this License-may add an explicit geographical distribution limitation excluding those-countries, so that distribution is permitted only in or among-countries not thus excluded.  In such case, this License incorporates-the limitation as if written in the body of this License.--  13. The Free Software Foundation may publish revised and/or new-versions of the Lesser General Public License from time to time.-Such new versions will be similar in spirit to the present version,-but may differ in detail to address new problems or concerns.--Each version is given a distinguishing version number.  If the Library-specifies a version number of this License which applies to it and-"any later version", you have the option of following the terms and-conditions either of that version or of any later version published by-the Free Software Foundation.  If the Library does not specify a-license version number, you may choose any version ever published by-the Free Software Foundation.--  14. If you wish to incorporate parts of the Library into other free-programs whose distribution conditions are incompatible with these,-write to the author to ask for permission.  For software which is-copyrighted by the Free Software Foundation, write to the Free-Software Foundation; we sometimes make exceptions for this.  Our-decision will be guided by the two goals of preserving the free status-of all derivatives of our free software and of promoting the sharing-and reuse of software generally.--                            NO WARRANTY--  15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO-WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.-EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR-OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY-KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR-PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE-LIBRARY IS WITH YOU.  SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME-THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.--  16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN-WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY-AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU-FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR-CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE-LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING-RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A-FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF-SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH-DAMAGES.--                     END OF TERMS AND CONDITIONS--           How to Apply These Terms to Your New Libraries--  If you develop a new library, and you want it to be of the greatest-possible use to the public, we recommend making it free software that-everyone can redistribute and change.  You can do so by permitting-redistribution under these terms (or, alternatively, under the terms-of the ordinary General Public License).--  To apply these terms, attach the following notices to the library.-It is safest to attach them to the start of each source file to most-effectively convey the exclusion of warranty; and each file should-have at least the "copyright" line and a pointer to where the full-notice is found.---    <one line to give the library's name and a brief idea of what it does.>-    Copyright (C) <year>  <name of author>--    This library is free software; you can redistribute it and/or-    modify it under the terms of the GNU Lesser General Public-    License as published by the Free Software Foundation; either-    version 2.1 of the License, or (at your option) any later version.--    This library 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-    Lesser General Public License for more details.--    You should have received a copy of the GNU Lesser General Public-    License along with this library; if not, write to the Free Software-    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA--Also add information on how to contact you by electronic and paper mail.--You should also get your employer (if you work as a programmer) or-your school, if any, to sign a "copyright disclaimer" for the library,-if necessary.  Here is a sample; alter the names:--  Yoyodyne, Inc., hereby disclaims all copyright interest in the-  library `Frob' (a library for tweaking knobs) written by James-  Random Hacker.--  <signature of Ty Coon>, 1 April 1990-  Ty Coon, President of Vice--That's all there is to it!--
− README
@@ -1,72 +0,0 @@-Introduction-============-Hslogger4j provides handlers for hslogger[1] (John Goerzen's Haskell logging library) that are compatible with log4j's XMLLayout. In particular log messages created by the handlers can be published directly to the GUI-based log viewer Chainsaw v2[2].--The set of log levels in hslogger is richer than the basic set of log4j levels. Two sets of handlers are provided with hslogger4j, one which produces logs with hslogger's levels and one which "demotes" them to the basic log4j levels. If full hslogger levels are used some Java installation is necessary to make Chainsaw aware of them.--Usage of the handlers in hslogger4j is analoguous to usage of the 'StreamHandler' and 'FileHandler' in 'System.Log.Handler.Simple'. The following handlers are provided:--  - log4jStreamHandler  (hslogger levels)-  - log4jFileHandler    (hslogger levels)-  - log4jStreamHandler' (log4j levels)-  - log4jFileHandler'   (log4j levels)---Installation-============-Haskell---------Use the regular cabal process:--  runhaskell Setup.lhs configure-  runhaskell Setup.lhs build-  runhaskell Setup.lhs install--Java------This is only necessary if you want to use the hslogger levels.--Add 'hslogger4j.jar' to your classpath. To use you will also need to have the jars 'log4j-1.3alpha-7.jar' and 'log4j-xml-1.3alpha-7.jar' that are distributed with Chainsaw on your classpath.--(On Mac OS X I added all three jars to '~/Library/Java/Extensions'. It seems that it is not sufficient that Chainsaw already includes its jars in the classpath when launching -- perhaps the plugin classloader does not inherit Chainsaw's classpath. Adding the jars to '~/.chainsaw/plugins' wouldn't work either.)--If for whatever reason you have to rebuild the hslogger4j jar just run 'ant'[3]. The new jar will be created in the 'dist/lib' directory.---Usage-=====-Haskell---------In the IO monad:--> lh2 <- log4jFileHandler "log.xml" DEBUG-> updateGlobalLogger rootLoggerName (addHandler lh2)--> h  <- connectTo "localhost" (PortNumber 4448)-> lh <- log4jStreamHandler h NOTICE-> updateGlobalLogger rootLoggerName (addHandler lh)--Chainsaw----------If you are only using the basic log4j levels just use Chainsaw's regular facilities to browse logs or listen for log messages (XMLSocketReceiver).--If you want to use the hslogger levels the easiest way to set up Chainsaw is to load the plugins in 'hslogger4j-plugins.xml' when launching Chainsaw. Two receivers will be defined, one that listens for logmessages and one for reading log files. Edit the properties of those receivers as needed (e.g. port, file name) and restart them.---Copyrights and licenses-=======================-The Haskell code is copyright John Goerzen and licensed under LGPL. The Java code is copyright of the Apache Software Foundation and licensed under the Apache License. See the source file headers for details.---Bugs, patches and stuff-=======================-Send to bjorn.buckwalter@gmail.com.---References-==========--  [1] http://software.complete.org/hslogger-  [2] http://logging.apache.org/chainsaw/-  [3] http://ant.apache.org/-
− build.xml
@@ -1,38 +0,0 @@-<project name="hslogger4j" default="dist" basedir=".">-    <description>-        simple example build file-    </description>-  <!-- set global properties for this build -->-  <property name="src"   location="java"/>-  <property name="build" location="build"/>-  <property name="dist"  location="dist"/>--  <target name="init">-    <!-- Create the time stamp -->-    <tstamp/>-    <!-- Create the build directory structure used by compile -->-    <mkdir dir="${build}"/>-  </target>--  <target name="compile" depends="init"-        description="compile the source " >-    <!-- Compile the java code from ${src} into ${build} -->-    <javac srcdir="${src}" destdir="${build}"/>-  </target>--  <target name="dist" depends="compile"-        description="generate the distribution" >-    <!-- Create the distribution directory -->-    <mkdir dir="${dist}/lib"/>--    <!-- Put everything in ${build} into the MyProject-${DSTAMP}.jar file -->-    <jar jarfile="${dist}/lib/hslogger4j-${DSTAMP}.jar" basedir="${build}"/>-  </target>--  <target name="clean"-        description="clean up" >-    <!-- Delete the ${build} and ${dist} directory trees -->-    <delete dir="${build}"/>-    <delete dir="${dist}"/>-  </target>-</project>
− haskell/System/Log/Handler/Log4jXML.hs
@@ -1,176 +0,0 @@-{- arch-tag: log4j XMLLayout log handler-Copyright (C) 2004-2006 John Goerzen <jgoerzen@complete.org>--This program is free software; you can redistribute it and/or modify-it under the terms of the GNU Lesser General Public License as published by-the Free Software Foundation; either version 2.1 of the License, or-(at your option) any later version.--This program 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 Lesser General Public License for more details.--You should have received a copy of the GNU Lesser General Public License-along with this program; if not, write to the Free Software-Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA--}--{- |-   Module     : System.Log.Handler.Log4jXML-   Copyright  : Copyright (C) 2004-2007 John Goerzen-   License    : GNU LGPL, version 2.1 or above--   Maintainer : bjorn.buckwalter@gmail.com-   Stability  : experimental-   Portability: GHC only?--log4j XMLLayout log handler--Written by Bjorn Buckwalter, bjorn.buckwalter\@gmail.com--}--{- The following is an example log message with log4j's XMLLayout:--<log4j:event logger="csa.Main" timestamp="1147868447298" level="DEBUG" thread="Timer-0">-<log4j:message><![CDATA[Doing Message Tasks : 0 tasks in queue.]]></log4j:message>-</log4j:event>---}--module System.Log.Handler.Log4jXML -    ( log4jStreamHandler , log4jFileHandler-    , log4jStreamHandler', log4jFileHandler'-    ) where---- Base.-import Control.Concurrent (ThreadId, myThreadId)  -- myThreadId is GHC only!-import Control.Concurrent.MVar-import Data.List (isPrefixOf)-import System.IO-import System.Locale (defaultTimeLocale)--- Time.-import Data.Time--- hslogger.-import System.Log-import System.Log.Handler----- Copied straight from 'System.Log.Handler.Simple'.-data GenericHandler a = GenericHandler {priority :: Priority,-                                        privData :: a,-                                        writeFunc :: a -> LogRecord -> String -> IO (),-                                        closeFunc :: a -> IO () }---- Copied straight from 'System.Log.Handler.Simple'.-instance LogHandler (GenericHandler a) where-    setLevel sh p = sh{priority = p}-    getLevel sh = priority sh-    emit sh lr loggername = (writeFunc sh) (privData sh) lr loggername-    close sh = (closeFunc sh) (privData sh)----- Handler that logs to a handle rendering message priorities according--- to the supplied function.-log4jHandler :: (Priority -> String) -> Handle -> Priority -> IO (GenericHandler Handle)-log4jHandler showPrio h pri = do-    lock <- newMVar ()-    let mywritefunc hdl (prio, msg) loggername = withMVar lock (\_ -> do -        time   <- getCurrentTime-        thread <- myThreadId-        hPutStrLn hdl (show $ createMessage loggername time prio thread msg)-        hFlush hdl-        )-    return (GenericHandler { priority  = pri,-                             privData  = h,-                             writeFunc = mywritefunc,-                             closeFunc = \x -> return () })-    where-        -- Creates an XML element representing a log4j event/message.-        createMessage :: String -> UTCTime -> Priority -> ThreadId -> String -> XML-        createMessage logger time prio thread msg = Elem "log4j:event" -            [ ("logger"   , logger       )-            , ("timestamp", millis time  )-            , ("level"    , showPrio prio)-            , ("thread"   , show thread  )-            ]-            (Just $ Elem "log4j:message" [] (Just $ CDATA msg))-            where-                -- This is an ugly hack to get a unix epoch with milliseconds.-                -- The use of "take 3" causes the milliseconds to always be -                -- rounded downwards, which I suppose may be the expected-                -- behaviour for time.-                millis t = formatTime defaultTimeLocale "%s" t-                    ++ (take 3 $ formatTime defaultTimeLocale "%q" t)----- | Logs to a handle using hslogger priorities.-log4jStreamHandler :: Handle -> Priority -> IO (GenericHandler Handle)-log4jStreamHandler = log4jHandler show---- | Logs to a handle using log4j levels (priorities). The priorities of--- messages are shoehorned into log4j levels as follows:---      DEBUG -> DEBUG---      INFO, NOTICE -> INFO---      WARNING -> WARN---      ERROR, CRITICAL, ALERT -> ERROR---      EMERGENCY -> FATAL--- This is useful when the log will only be consumed by log4j tools and--- you don't want to go out of your way transforming the log or configuring--- the tools.-log4jStreamHandler' :: Handle -> Priority -> IO (GenericHandler Handle)-log4jStreamHandler' = log4jHandler show' where-    show' :: Priority -> String-    show' NOTICE    = "INFO"-    show' WARNING   = "WARN"-    show' CRITICAL  = "ERROR"-    show' ALERT     = "ERROR"-    show' EMERGENCY = "FATAL"-    show' p         = show p  -- Identical for DEBUG, INFO, ERROR.---- | Log to a file with hslogger priorities.-log4jFileHandler :: FilePath -> Priority -> IO (GenericHandler Handle)-log4jFileHandler fp pri = openFile fp AppendMode -    >>= (flip log4jStreamHandler) pri-    >>= \lh -> return $ lh { closeFunc = hClose }---- | Log to a file with log4j priorities.-log4jFileHandler' :: FilePath -> Priority -> IO (GenericHandler Handle)-log4jFileHandler' fp pri = openFile fp AppendMode -    >>= (flip log4jStreamHandler') pri-    >>= \lh -> return $ lh { closeFunc = hClose }----- A type for building and showing XML elements. Could use a fancy XML--- library but am reluctant to introduce dependencies.-data XML = Elem  String [(String, String)] (Maybe XML)-         | CDATA String-      -- | Text  String--instance Show XML where-    show (CDATA s) = "<![CDATA[" ++ escapeCDATA s ++ "]]>" where-        escapeCDATA = replace "]]>" "]]&lt;"  -- The best we can do, I guess.-    show (Elem name attrs child) = "<" ++ name ++ showAttrs attrs ++ showChild child where-        showAttrs []         = ""-        showAttrs ((k,v):as) = " " ++ k ++ "=\"" ++ escapeAttr v ++ "\"" -                             ++ showAttrs as-            where escapeAttr = replace "\"" "&quot;" -                             . replace "<" "&lt;" -                             . replace "&" "&amp;"-        showChild Nothing  = "/>"-        showChild (Just c) = ">" ++ show c ++ "</" ++ name ++ ">"----- Replaces instances of first list by second list in third list.--- Definition blatantly stoled from jethr0's comment at--- http://bluebones.net/2007/01/replace-in-haskell/. Can be swapped--- with definition (or import) from MissingH.-replace :: Eq a => [a] -> [a] -> [a] -> [a]-replace _    _  [       ] = []-replace from to xs@(a:as) = if isPrefixOf from xs-    then to ++ drop (length from) xs else a : replace from to as--        -test1 = Elem "log4j:event" [("time","1234"), ("level", "WARN")] Nothing-test2 = Elem "log4j:event" [("time","1234"), ("level", "WARN")] $ Just $ Elem "log4j:message" [] $ Just $ CDATA "My log message"-
− hslogger4j-plugins.xml
@@ -1,22 +0,0 @@-<?xml version="1.0" encoding="UTF-8" ?>-<!DOCTYPE log4j:configuration >-<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/" debug="true">--  <plugin name="Hslogger4jSocketReceiver" -          class="org.apache.log4j.net.XMLSocketReceiver">-          <param name="decoder" value="org.haskell.hslogger4j.XMLDecoder"/>-    <param name="Port" value="4448"/>-    <level value="DEBUG"/>-  </plugin>--  <plugin name="Hslogger4jFileReader" -          class="org.haskell.hslogger4j.LogFileXMLReceiver">-    <param name="decoder" value="org.haskell.hslogger4j.XMLDecoder"/>-  </plugin>--  <root>-    <level value="debug"/>-  </root>--</log4j:configuration>-
hslogger4j.cabal view
@@ -1,27 +1,26 @@ Name:           hslogger4j-Version:        0.1.1+Version:        0.2 License:        LGPL license-file:   COPYRIGHT-Copyright:      Copyright (c) 2004-2007 John Goerzen+Copyright:      Copyright (c) 2004-2008 John Goerzen Author:         Bjorn Buckwalter Maintainer:     bjorn.buckwalter@gmail.com-Stability:      Experimental+Stability:      Deprecated Homepage:       http://hslogger4j.googlecode.com/-Synopsis: hslogger handlers for log4j's XMLLayout+Synopsis: DEPRECATED hslogger handlers for log4j's XMLLayout Description: -    Hslogger4j provides handlers for hslogger (John Goerzen's Haskell-    logging library) that are compatible with log4j's XMLLayout. In-    particular log messages created by the handlers can be published-    directly to the GUI-based log viewer Chainsaw v2.+    The hslogger4j code has been contributed to hslogger (included in+    version 1.0.6) and this package has been DEPRECATED.+    This version contains no code. Category:       Interfaces-Build-Depends:  base, time, hslogger-Hs-Source-Dirs: haskell+Build-Type:     Simple+Build-Depends:  hslogger >= 1.0.6 Exposed-Modules: -    System.Log.Handler.Log4jXML+    -- System.Log.Handler.Log4jXML Extra-source-files:-    COPYING, README, hslogger4j.jar,-    hslogger4j-plugins.xml, build.xml,-    java/org/haskell/hslogger/HsloggerLevel.java,-    java/org/haskell/hslogger/XMLDecoder.java,-    java/org/haskell/hslogger/LogFileXMLReceiver.java+    -- COPYING, README, hslogger4j.jar,+    -- hslogger4j-plugins.xml, build.xml,+    -- java/org/haskell/hslogger/HsloggerLevel.java,+    -- java/org/haskell/hslogger/XMLDecoder.java,+    -- java/org/haskell/hslogger/LogFileXMLReceiver.java 
− hslogger4j.jar

binary file changed (9129 → absent bytes)

− java/org/haskell/hslogger/HsloggerLevel.java
@@ -1,154 +0,0 @@-/*- * Copyright 1999,2004 The Apache Software Foundation.- * - * Licensed under the Apache License, Version 2.0 (the "License");- * you may not use this file except in compliance with the License.- * You may obtain a copy of the License at- * - *      http://www.apache.org/licenses/LICENSE-2.0- * - * Unless required by applicable law or agreed to in writing, software- * distributed under the License is distributed on an "AS IS" BASIS,- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.- * See the License for the specific language governing permissions and- * limitations under the License.- */--package org.haskell.hslogger4j;--import java.util.ArrayList;-import java.util.List;--import org.apache.log4j.Level;--/**- *  An extension of the Level class that provides support for java.util.logging - * Levels.- *- *  @author Scott Deboy <sdeboy@apache.org>- *- */--public class HsloggerLevel extends org.apache.log4j.Level {--  public final static int EMERGENCY_INT = 51000; // FATAL-  public final static int ALERT_INT     = 50000;-  public final static int CRITICAL_INT  = 41000;-  public final static int ERROR_INT     = 40000; // ERROR-  public final static int WARNING_INT   = 30000; // WARN-  public final static int NOTICE_INT    = 21000;-  public static final int INFO_INT      = 20000; // INFO-  public static final int DEBUG_INT     = 10000; // DEBUG-  -  public static final HsloggerLevel EMERGENCY = new HsloggerLevel(EMERGENCY_INT, "EMERGENCY", 0);-  public static final HsloggerLevel ALERT     = new HsloggerLevel(ALERT_INT    , "ALERT"    , 1);      -  public static final HsloggerLevel CRITICAL  = new HsloggerLevel(CRITICAL_INT , "CRITICAL" , 2);      -  public static final HsloggerLevel ERROR     = new HsloggerLevel(ERROR_INT    , "ERROR"    , 3);-  public static final HsloggerLevel WARNING   = new HsloggerLevel(WARNING_INT  , "WARNING"  , 4);-  public static final HsloggerLevel NOTICE    = new HsloggerLevel(NOTICE_INT   , "NOTICE"   , 5);-  public static final HsloggerLevel INFO      = new HsloggerLevel(INFO_INT     , "INFO"     , 6);-  public static final HsloggerLevel DEBUG     = new HsloggerLevel(DEBUG_INT    , "DEBUG"    , 7);--  protected HsloggerLevel(int level, String levelStr, int syslogEquivalent) {-    super(level, levelStr, syslogEquivalent);-  }--  /**-    Convert an integer passed as argument to a level. If the-    conversion fails, then this method returns the specified default.-  */-  public static HsloggerLevel toLevel(int val, HsloggerLevel defaultLevel) {-    switch (val) {-    case EMERGENCY_INT:-      return EMERGENCY;--    case ALERT_INT:-      return ALERT;--    case CRITICAL_INT:-      return CRITICAL;--    case ERROR_INT:-      return ERROR;--    case WARNING_INT:-      return WARNING;--    case NOTICE_INT:-      return NOTICE;-      -    case INFO_INT:-      return INFO;--    case DEBUG_INT:-      return DEBUG;--    default:-      return defaultLevel;-    }-  }--  public static Level toLevel(int val) {-    return toLevel(val, CRITICAL);-  }--  public static List getAllPossibleLevels() {-  	ArrayList list=new ArrayList();-  	list.add(DEBUG);-  	list.add(INFO);-  	list.add(NOTICE);-  	list.add(WARNING);-  	list.add(ERROR);-  	list.add(CRITICAL);-  	list.add(ALERT);-  	list.add(EMERGENCY);-  	return list;-  }--  public static Level toLevel(String s) {-  	return toLevel(s, Level.DEBUG);-  }-  -  public static Level toLevel(String sArg, Level defaultLevel) {-    if (sArg == null) {-      return defaultLevel;-    }--    String s = sArg.toUpperCase();--    if (s.equals("EMERGENCY")) {-      return EMERGENCY;-    }--    if (s.equals("ALERT")) {-      return ALERT;-    }--    if (s.equals("CRITICAL")) {-      return CRITICAL;-    }--    if (s.equals("ERROR")) {-      return ERROR;-    }--    if (s.equals("WARNING")) {-      return WARNING;-    }--    if (s.equals("NOTICE")) {-      return NOTICE;-    }--    if (s.equals("INFO")) {-      return INFO;-    }--    if (s.equals("DEBUG")) {-      return DEBUG;-    }-    return defaultLevel;-  }--}-
− java/org/haskell/hslogger/LogFileXMLReceiver.java
@@ -1,303 +0,0 @@-/*
- * Copyright 1999,2004 The Apache Software Foundation. Licensed under the Apache License, Version
- * 2.0 (the "License"); you may not use this file except in compliance with the License. You may
- * obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by
- * applicable law or agreed to in writing, software distributed under the License is distributed on
- * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See
- * the License for the specific language governing permissions and limitations under the License.
- */
-
-package org.haskell.hslogger4j;
-
-import java.io.BufferedReader;
-import java.io.FileNotFoundException;
-import java.io.IOException;
-import java.io.InputStreamReader;
-import java.io.Reader;
-import java.net.MalformedURLException;
-import java.net.URL;
-import java.util.Collection;
-import java.util.Iterator;
-
-import org.apache.log4j.xml.*;
-import org.apache.log4j.helpers.Constants;
-import org.apache.log4j.plugins.Receiver;
-import org.apache.log4j.rule.ExpressionRule;
-import org.apache.log4j.rule.Rule;
-import org.apache.log4j.spi.Decoder;
-import org.apache.log4j.spi.LoggingEvent;
-
-/**
- * LogFileXMLReceiver will read an xml-formated log file and make the events in the log file
- * available to the log4j framework.
- * <p>
- * This receiver supports log files created using log4j's XMLLayout, as well as java.util.logging
- * XMLFormatter (via the org.apache.log4j.spi.Decoder interface).
- * <p>
- * By default, log4j's XMLLayout is supported (no need to specify a decoder in that case).
- * <p>
- * To configure this receiver to support java.util.logging's XMLFormatter, specify a 'decoder' param
- * of org.apache.log4j.xml.UtilLoggingXMLDecoder.
- * <p>
- * Tailing -may- work, but not in all cases (try using a file:// URL). If a process has a log file
- * open, the receiver may be able to read and tail the file. If the process closes the file and
- * reopens the file, the receiver may not be able to continue tailing the file.
- * <p>
- * An expressionFilter may be specified. Only events passing the expression will be forwarded to the
- * log4j framework.
- * <p>
- * Once the event has been "posted", it will be handled by the appenders currently configured in the
- * LoggerRespository.
- * 
- * @author Scott Deboy <sdeboy@apache.org>
- * @since 1.3
- */
-
-public class LogFileXMLReceiver extends Receiver {
-    private String fileURL;
-    private Rule expressionRule;
-    private String filterExpression;
-    private String decoder = "org.apache.log4j.xml.XMLDecoder";
-    private boolean tailing = false;
-
-    private Decoder decoderInstance;
-    private Reader reader;
-    private static final String FILE_KEY = "file";
-    private String host;
-    private String path;
-    private boolean useCurrentThread;
-
-    /**
-     * Accessor
-     * 
-     * @return file URL
-     */
-    public String getFileURL() {
-        return fileURL;
-    }
-
-    /**
-     * Specify the URL of the XML-formatted file to process.
-     * 
-     * @param fileURL
-     */
-    public void setFileURL(String fileURL) {
-        this.fileURL = fileURL;
-    }
-
-    /**
-     * Accessor
-     * 
-     * @return
-     */
-    public String getDecoder() {
-        return decoder;
-    }
-
-    /**
-     * Specify the class name implementing org.apache.log4j.spi.Decoder that can process the file.
-     * 
-     * @param _decoder
-     */
-    public void setDecoder(String _decoder) {
-        decoder = _decoder;
-    }
-
-    /**
-     * Accessor
-     * 
-     * @return filter expression
-     */
-    public String getFilterExpression() {
-        return filterExpression;
-    }
-
-    /**
-     * Accessor
-     * 
-     * @return tailing flag
-     */
-    public boolean isTailing() {
-        return tailing;
-    }
-
-    /**
-     * Set the 'tailing' flag - may only work on file:// URLs and may stop tailing if the writing
-     * process closes the file and reopens.
-     * 
-     * @param tailing
-     */
-    public void setTailing(boolean tailing) {
-        this.tailing = tailing;
-    }
-
-    /**
-     * Set the filter expression that will cause only events which pass the filter to be forwarded
-     * to the log4j framework.
-     * 
-     * @param filterExpression
-     */
-    public void setFilterExpression(String filterExpression) {
-        this.filterExpression = filterExpression;
-    }
-
-    private boolean passesExpression(LoggingEvent event) {
-        if (event != null) {
-            if (expressionRule != null) {
-                return (expressionRule.evaluate(event));
-            }
-        }
-        return true;
-    }
-
-    public static void main(String[] args) {
-        /*
-         * LogFileXMLReceiver test = new LogFileXMLReceiver();
-         * test.setFileURL("file:///c:/samplelog.xml"); test.setFilterExpression("level >= TRACE");
-         * test.activateOptions();
-         */
-    }
-
-    /**
-     * Close the receiver, release any resources that are accessing the file.
-     */
-    public void shutdown() {
-        try {
-            if (reader != null) {
-                reader.close();
-                reader = null;
-            }
-        } catch (IOException ioe) {
-            ioe.printStackTrace();
-        }
-    }
-
-    /**
-     * Process the file
-     */
-    public void activateOptions() {
-        Runnable runnable = new Runnable() {
-            public void run() {
-                try {
-                    URL url = new URL(fileURL);
-                    host = url.getHost();
-                    if (host != null && host.equals("")) {
-                        host = FILE_KEY;
-                    }
-                    path = url.getPath();
-                } catch (MalformedURLException e1) {
-                    // TODO Auto-generated catch block
-                    e1.printStackTrace();
-                }
-
-                try {
-                    if (filterExpression != null) {
-                        expressionRule = ExpressionRule.getRule(filterExpression);
-                    }
-                } catch (Exception e) {
-                    getLogger().warn("Invalid filter expression: " + filterExpression, e);
-                }
-
-                Class c;
-                try {
-                    c = Class.forName(decoder);
-                    Object o = c.newInstance();
-                    if (o instanceof Decoder) {
-                        decoderInstance = (Decoder) o;
-                    }
-                } catch (ClassNotFoundException e) {
-                    // TODO Auto-generated catch block
-                    e.printStackTrace();
-                } catch (InstantiationException e) {
-                    // TODO Auto-generated catch block
-                    e.printStackTrace();
-                } catch (IllegalAccessException e) {
-                    // TODO Auto-generated catch block
-                    e.printStackTrace();
-                }
-
-                try {
-                    reader = new InputStreamReader(new URL(getFileURL()).openStream());
-                    process(reader);
-                } catch (FileNotFoundException fnfe) {
-                    getLogger().info("file not available");
-                } catch (IOException ioe) {
-                    getLogger().warn("unable to load file", ioe);
-                    return;
-                }
-            }
-        };
-        if (useCurrentThread) {
-            runnable.run();
-        } else {
-            Thread thread = new Thread(runnable, "LogFileXMLReceiver-" + getName());
-
-            thread.start();
-
-        }
-    }
-
-    private void process(Reader unbufferedReader) throws IOException {
-        BufferedReader bufferedReader = new BufferedReader(unbufferedReader);
-        char[] content = new char[10000];
-        getLogger().debug("processing starting: " + fileURL);
-        int length = 0;
-        do {
-            System.out.println("in do loop-about to process");
-            while ((length = bufferedReader.read(content)) > -1) {
-                processEvents(decoderInstance.decodeEvents(String.valueOf(content, 0, length)));
-            }
-            if (tailing) {
-                try {
-                    Thread.sleep(5000);
-                } catch (InterruptedException e) {
-                    // TODO Auto-generated catch block
-                    e.printStackTrace();
-                }
-            }
-        } while (tailing);
-        getLogger().debug("processing complete: " + fileURL);
-
-        shutdown();
-    }
-
-    private void processEvents(Collection c) {
-        if (c == null) {
-            return;
-        }
-
-        for (Iterator iter = c.iterator(); iter.hasNext();) {
-            LoggingEvent evt = (LoggingEvent) iter.next();
-            if (passesExpression(evt)) {
-                if (evt.getProperty(Constants.HOSTNAME_KEY) != null) {
-                    evt.setProperty(Constants.HOSTNAME_KEY, host);
-                }
-                if (evt.getProperty(Constants.APPLICATION_KEY) != null) {
-                    evt.setProperty(Constants.APPLICATION_KEY, path);
-                }
-                doPost(evt);
-            }
-        }
-    }
-
-    /**
-     * When true, this property uses the current Thread to perform the import, otherwise when false
-     * (the default), a new Thread is created and started to manage the import.
-     * 
-     * @return
-     */
-    public final boolean isUseCurrentThread() {
-        return useCurrentThread;
-    }
-
-    /**
-     * Sets whether the current Thread or a new Thread is created to perform the import, the default
-     * being false (new Thread created).
-     * 
-     * @param useCurrentThread
-     */
-    public final void setUseCurrentThread(boolean useCurrentThread) {
-        this.useCurrentThread = useCurrentThread;
-    }
-
-}
− java/org/haskell/hslogger/XMLDecoder.java
@@ -1,410 +0,0 @@-/*- * Copyright 1999,2004 The Apache Software Foundation.- * - * Licensed under the Apache License, Version 2.0 (the "License");- * you may not use this file except in compliance with the License.- * You may obtain a copy of the License at- * - *      http://www.apache.org/licenses/LICENSE-2.0- * - * Unless required by applicable law or agreed to in writing, software- * distributed under the License is distributed on an "AS IS" BASIS,- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.- * See the License for the specific language governing permissions and- * limitations under the License.- */--package org.haskell.hslogger4j;--import java.awt.Component;-import java.io.IOException;-import java.io.InputStreamReader;-import java.io.LineNumberReader;-import java.io.StringReader;-import java.net.URL;-import java.util.HashMap;-import java.util.Hashtable;-import java.util.Iterator;-import java.util.Map;-import java.util.Vector;--import javax.swing.ProgressMonitorInputStream;-import javax.xml.parsers.DocumentBuilder;-import javax.xml.parsers.DocumentBuilderFactory;-import javax.xml.parsers.ParserConfigurationException;--import org.apache.log4j.xml.*;-import org.apache.log4j.Level;-import org.apache.log4j.Logger;-import org.apache.log4j.spi.Decoder;-import org.apache.log4j.spi.LoggingEvent;-import org.apache.log4j.spi.ThrowableInformation;-import org.w3c.dom.Document;-import org.w3c.dom.Node;-import org.w3c.dom.NodeList;-import org.xml.sax.InputSource;---/**- * Decodes Logging Events in XML formated into elements that are used by- * Chainsaw.- *- * This decoder can process a collection of log4j:event nodes ONLY - * (no XML declaration nor eventSet node)- * - * NOTE:  Only a single LoggingEvent is returned from the decode method- * even though the DTD supports multiple events nested in an eventSet.- *- * @author Scott Deboy <sdeboy@apache.org>- * @author Paul Smith <psmith@apache.org>- *- */-public class XMLDecoder implements Decoder {-  private static final String BEGINPART =-    "<?xml version=\"1.0\" encoding=\"UTF-8\" ?><!DOCTYPE log4j:eventSet SYSTEM \"log4j.dtd\"><log4j:eventSet version=\"1.2\" xmlns:log4j=\"http://jakarta.apache.org/log4j/\">";-  private static final String ENDPART = "</log4j:eventSet>";-  private static final String RECORD_END = "</log4j:event>";-  private DocumentBuilderFactory dbf;-  private DocumentBuilder docBuilder;-  private Map additionalProperties = new HashMap();-  private String partialEvent;-  private Component owner = null;--  public XMLDecoder(Component owner) {-      this();-      this.owner = owner;-  }-  public XMLDecoder() {-    dbf = DocumentBuilderFactory.newInstance();-    dbf.setValidating(false);--    try {-      docBuilder = dbf.newDocumentBuilder();-      docBuilder.setErrorHandler(new SAXErrorHandler());-      docBuilder.setEntityResolver(new Log4jEntityResolver());-    } catch (ParserConfigurationException pce) {-      System.err.println("Unable to get document builder");-    }-  }--  /**-   * Sets an additionalProperty map, where each Key/Value pair is-   * automatically added to each LoggingEvent as it is decoded.-   *-   * This is useful, say, to include the source file name of the Logging events-   * @param additionalProperties-   */-  public void setAdditionalProperties(Map additionalProperties) {-    this.additionalProperties = additionalProperties;-  }--  /**-   * Converts the LoggingEvent data in XML string format into an actual-   * XML Document class instance.-   * @param data-   * @return dom document-   */-  private Document parse(String data) {-    if (docBuilder == null || data == null) {-      return null;-    }-    Document document = null;--    try {-      // we change the system ID to a valid URI so that Crimson won't-      // complain. Indeed, "log4j.dtd" alone is not a valid URI which-      // causes Crimson to barf. The Log4jEntityResolver only cares-      // about the "log4j.dtd" ending.-      //      buf.setLength(0);--      /**-       * resetting the length of the StringBuffer is dangerous, particularly-       * on some JDK 1.4 impls, there's a known Bug that causes a memory leak-       */-      StringBuffer buf = new StringBuffer(1024);--      buf.append(BEGINPART);-      buf.append(data);-      buf.append(ENDPART);--      InputSource inputSource =-        new InputSource(new StringReader(buf.toString()));-      inputSource.setSystemId("dummy://log4j.dtd");-      document = docBuilder.parse(inputSource);-    } catch (Exception e) {-      e.printStackTrace();-    }--    return document;-  }--  /**-   * Decodes a File into a Vector of LoggingEvents-   * @param url the url of a file containing events to decode-   * @return Vector of LoggingEvents-   * @throws IOException-   */-  public Vector decode(URL url) throws IOException {-    LineNumberReader reader = null;-    if (owner != null) {-      reader = new LineNumberReader(new InputStreamReader(new ProgressMonitorInputStream(owner, "Loading " + url , url.openStream())));-    } else {-      reader = new LineNumberReader(new InputStreamReader(url.openStream()));-    }--    Vector v = new Vector();--    String line = null;-	Vector events = null;-    try {-        while ((line = reader.readLine()) != null) {-            StringBuffer buffer = new StringBuffer(line);-            for (int i = 0;i<1000;i++) {-                buffer.append(reader.readLine()).append("\n");-            }-			events = decodeEvents(buffer.toString());-            if (events != null)-            	v.addAll(events);-        }-    } finally {-      partialEvent = null;-      try {-        if (reader != null) {-          reader.close();-        }-      } catch (Exception e) {-        e.printStackTrace();-      }-    }-    return v;-  }--  public Vector decodeEvents(String document) {-    if (document != null) {-      if (document.trim().equals("")) {-        return null;-      }-	  	String newDoc=null;-	  	String newPartialEvent=null;-	  	//separate the string into the last portion ending with </log4j:event> (which will-	  	//be processed) and the partial event which will be combined and processed in the next section-	-		//if the document does not contain a record end, append it to the partial event string-	  	if (document.lastIndexOf(RECORD_END) == -1) {-			partialEvent = partialEvent + document;-	  		return null;-	  	}-	-	  	if (document.lastIndexOf(RECORD_END) + RECORD_END.length() < document.length()) {-	      	newDoc = document.substring(0, document.lastIndexOf(RECORD_END) + RECORD_END.length());-			newPartialEvent = document.substring(document.lastIndexOf(RECORD_END) + RECORD_END.length());-	 	} else {-	  		newDoc = document;-	  	}-		if (partialEvent != null) {-			newDoc=partialEvent + newDoc;-		}	      		-	  	partialEvent=newPartialEvent;-	    Document doc = parse(newDoc);-	    if (doc == null) {-	      return null;-	    }-	    return decodeEvents(doc);-    }-    return null;-  }--  /**-   * Converts the string data into an XML Document, and then soaks out the-   * relevant bits to form a new LoggingEvent instance which can be used-   * by any Log4j element locally.-   * @param data-   * @return a single LoggingEvent-   */-  public LoggingEvent decode(String data) {-    Document document = parse(data);--    if (document == null) {-      return null;-    }--    Vector events = decodeEvents(document);--    if (events.size() > 0) {-      return (LoggingEvent) events.firstElement();-    }--    return null;-  }--  /**-   * Given a Document, converts the XML into a Vector of LoggingEvents-   * @param document-   * @return Vector of LoggingEvents-   */-  private Vector decodeEvents(Document document) {-    Vector events = new Vector();--    Logger logger = null;-    long timeStamp = 0L;-    String level = null;-    String threadName = null;-    Object message = null;-    String ndc = null;-    String[] exception = null;-    String className = null;-    String methodName = null;-    String fileName = null;-    String lineNumber = null;-    Hashtable properties = null;--    NodeList nl = document.getElementsByTagName("log4j:eventSet");-    Node eventSet = nl.item(0);--    NodeList eventList = eventSet.getChildNodes();--    for (int eventIndex = 0; eventIndex < eventList.getLength();-        eventIndex++) {-      Node eventNode = eventList.item(eventIndex);-      //ignore carriage returns in xml -	  if(eventNode.getNodeType() != Node.ELEMENT_NODE) {-	  	continue;-	  }-      logger =-        Logger.getLogger(-          eventNode.getAttributes().getNamedItem("logger").getNodeValue());-      timeStamp =-        Long.parseLong(-          eventNode.getAttributes().getNamedItem("timestamp").getNodeValue());-      level =eventNode.getAttributes().getNamedItem("level").getNodeValue();-      threadName =-        eventNode.getAttributes().getNamedItem("thread").getNodeValue();--      NodeList list = eventNode.getChildNodes();-      int listLength = list.getLength();--      for (int y = 0; y < listLength; y++) {-        String tagName = list.item(y).getNodeName();--        if (tagName.equalsIgnoreCase("log4j:message")) {-          message = getCData(list.item(y));-        }--        if (tagName.equalsIgnoreCase("log4j:NDC")) {-          ndc = getCData(list.item(y));-        }-        //still support receiving of MDC and convert to properties-        if (tagName.equalsIgnoreCase("log4j:MDC")) {-          properties = new Hashtable();-          NodeList propertyList = list.item(y).getChildNodes();-          int propertyLength = propertyList.getLength();--          for (int i = 0; i < propertyLength; i++) {-            String propertyTag = propertyList.item(i).getNodeName();--            if (propertyTag.equalsIgnoreCase("log4j:data")) {-              Node property = propertyList.item(i);-              String name =-                property.getAttributes().getNamedItem("name").getNodeValue();-              String value =-                property.getAttributes().getNamedItem("value").getNodeValue();-              properties.put(name, value);-            }-          }-        }--        if (tagName.equalsIgnoreCase("log4j:throwable")) {-          exception = new String[] { getCData(list.item(y)) };-        }--        if (tagName.equalsIgnoreCase("log4j:properties")) {-          if (properties == null) {-              properties = new Hashtable();-          }-          NodeList propertyList = list.item(y).getChildNodes();-          int propertyLength = propertyList.getLength();--          for (int i = 0; i < propertyLength; i++) {-            String propertyTag = propertyList.item(i).getNodeName();--            if (propertyTag.equalsIgnoreCase("log4j:data")) {-              Node property = propertyList.item(i);-              String name =-                property.getAttributes().getNamedItem("name").getNodeValue();-              String value =-                property.getAttributes().getNamedItem("value").getNodeValue();-              properties.put(name, value);-            }-          }-        }--        /**-         * We add all the additional properties to the properties-         * hashtable.  Don't override properties that already exist-         */-        if (additionalProperties.size() > 0) {-          if (properties == null) {-            properties = new Hashtable(additionalProperties);-          } else {-            Iterator i = additionalProperties.entrySet().iterator();-            while (i.hasNext()) {-              Map.Entry e = (Map.Entry) i.next();-              if (!(properties.containsKey(e.getKey()))) {-              	properties.put(e.getKey(), e.getValue());-              }-            }-          }-        }-      }-      Level levelImpl = HsloggerLevel.toLevel(level);-      -      if (exception == null) {-          exception = new String[]{""};-      }-      -      LoggingEvent loggingEvent = new LoggingEvent();-      loggingEvent.setLogger(logger);-      loggingEvent.setTimeStamp(timeStamp);-      loggingEvent.setLevel(levelImpl);-      loggingEvent.setThreadName(threadName);-      loggingEvent.setMessage(message);-      loggingEvent.setNDC(ndc);-      loggingEvent.setThrowableInformation(new ThrowableInformation(exception));-      loggingEvent.setProperties(properties);-      -      events.add(loggingEvent);-     -      logger = null;-      timeStamp = 0L;-      level = null;-      threadName = null;-      message = null;-      ndc = null;-      exception = null;-      className = null;-      methodName = null;-      fileName = null;-      lineNumber = null;-      properties = null;-    }--    return events;-  }--  private String getCData(Node n) {-    StringBuffer buf = new StringBuffer();-    NodeList nl = n.getChildNodes();--    for (int x = 0; x < nl.getLength(); x++) {-      Node innerNode = nl.item(x);--      if (-        (innerNode.getNodeType() == Node.TEXT_NODE)-          || (innerNode.getNodeType() == Node.CDATA_SECTION_NODE)) {-        buf.append(innerNode.getNodeValue());-      }-    }--    return buf.toString();-  }-}