diff options
Diffstat (limited to 'README')
| -rwxr-xr-x | README | 318 |
1 files changed, 141 insertions, 177 deletions
@@ -1,7 +1,5 @@ -yhttpd; Homepage: www.yhttpd.org; Version 0.7.1-RELEASE - +yChat++ Basic; Homepage: www.yChat.org; Version 0.5.1 Copyright (C) 2003 Paul C. Buetow, Volker Richter -Copyright (C) 2004 Paul C. Buetow ----------------------------------------------------------------- This program is free software; you can redistribute it and/or @@ -17,246 +15,221 @@ GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. ------------------------------------------------------------------ -YHTTPD TABLE OF CONTENTS: +----------------------------------------------------------------- +0.0.0 YCHAT++ BASIC TABLE OF CONTENTS 1.0.0 REQUIREMENTS 1.1.0 TESTED PLATFORMS -1.2.0 IMPORTANT NOTICES -1.3.0 HOW TO OBTAIN YHTTPD +1.2.0 IMPORTANT NOTES +1.3.0 HOW TO OBTAIN YCHAT++ 1.3.1 INSTALLATION -1.3.2 INSTALLATION QUICK-START -1.4.0 HOW TO USE SCREEN WITH YHTTPD 1.5.0 CUSTOMIZATION 1.6.0 FILES 1.7.0 WRITING BUG REPORTS 1.8.0 CONTACT - 1.0.0 REQUIREMENTS: -- GNU GCC G++ 3.4 or 3.3 or 3.2 or 3.1 - The GNU C++ compiler. G++ version 3.0 or 2.x does NOT work. +- gcc 3.2 + The GNU C++ compiler. -- GNU make 3.80 (gmake) or higher - If you dont have a gmake executable but make is gnu make then you need - to add a symlink or alias from gmake to make. - yhttpd Makefiles only have been tested with GNU make and may not work with - other make versions. +1.1.0 TESTED PLATFORMS: -- ncurses 5.x - Includes libncurses and the ncurses.h header files. +The following platforms have been tested with success: -- Screen - Only needed if yhttpd should run in background with - ncurses or CLI enabled. +- Linux with GCC 3.2.0, GNU make 3.79.1 +- FreeBSD 5.1-RELEASE-p2, GCC 3.2.2, GNU make 3.80 ( standard make does not seem work on FreeBSD ). -- Perl 5.x - Is needed for some scripts. Is not needed if you use precompiled binaries. +1.2.0 IMPORTANT NOTES: -1.1.0 TESTED PLATFORMS: +Before you compile the source you have to be sure to use at least GCC +version 3.x with pthreads enabled. ( Type gcc -v to check it ). +GCC 2.95 did not work while testing on linux and WON'T BE SUPPORTED! +If you like to support yChat++, please write us an email and tell what +you can/like/would help ;-]. Please also take a look at the yChat++ +homepage which is located at http://www.yChat.org. -The following platforms have been tested with success. If you find out that -a listed platform did not work at all please contact me: +1.3.0 HOW TO OBTAIN YCHAT++: - Operating system (arch) GNU G++ GNU make -- FreeBSD 5.2.1-RELEASE (i386) 3.3.3 3.80 -- FreeBSD 4.9-RELEASE (i386) 3.3.4 3.80 -- FreeBSD 4.10-RELEASE (i386) 3.4.1 3.80 -- Gentoo Linux 2004.2 (i386) 3.3.2 3.80 -- OpenBSD 3.6 MP (i386) 3.3.2 3.80 -- Slackware Linux 10.0 (i386) 3.4.0 3.80 -- SUSE Linux 8.0, G (i386) 3.3.1 3.80 +yChat can be downloaded as a source package or through CVS. -Other platforms like Linux based systems, other BSD-Systems or UNICES -are very likely to work too. +The packages are located at http://www.yChat.org -> Sourcecode -> +Packages or go to http://programming.buetow.org/CPP-yChat . -1.2.0 IMPORTANT NOTICES: +For CVS download type also look at the homepage please. -Before you compile the source you have to be sure to use at least GCC -version 3.1 with pthreads enabled. ( Type gcc -v to check it ). -GCC 2.95 and 3.0 did not work while testing and WON'T BE SUPPORTED! -If you like to support yhttpd++, please write us an email and tell what -you can/like/would help ;-]. Please also take a look at the yhttpd++ -homepage which is located at http://www.yhttpd.org. +1.3.1 INSTALLATION: -1.3.0 HOW TO OBTAIN YHTTPD++: +Invoke "./configure" and afterwards "make", edit the conf.txt. -yhttpd can be downloaded as a source package or through CVS. +Now we want to compile all the dynamic loadable modules of ychat. +Invoke "cd cmnd && ./compile.sh && cd -". All command modules should get +compiled. -The packages are located at http://www.yhttpd.org -> Sourcecode -> -Packages or go to http://pub.buetow.org/yhttpd/CPP-yhttpd . +Now its time to run the server with ./ychat. +Then point your webbrowser to http://yourip:port ! -For CVS download type: +... have fun :-). -cvs -d:pserver:anonymous@buetow.org:/usr/home/cvs/cvsroot login -( You will be asked for a password. Use "just enter" ). +1.5.0 CUSTOMIZATION: -vs -z3 -d:pserver:anonymous@buetow.org:/usr/home/cvs/cvsroot co yhttpd -( The sources will be copied into your local folder ) +If you like to customize the design/layout/language of yChat, you will have +to edit msgs.h and glob.h before you compile the sources. Afterwards you can +change the html-template files which are placed in the html/ subdirectory. +Dynamic loadable modules can be found in the cmnd/ subdirectory. -cvs -d:pserver:anonymous@buetow.org:/usr/home/cvs/cvsroot logout -( Logs your CVS session out ). +1.6.0 FILES: ( This list is not complete ) -Now you may continue with the installation. +conf.txt - The yChat configuration file. ( read by conf.cpp ). -1.3.1 INSTALLATION: +base.cpp - Encapsulates vector fields of room's or user ( may be later + hash_maps ) and provides methods for manipulating data + objects. -Invoke "./configure". Afterwards you will get prompted with the before-compile -options of yhttpd. After choosing those options you are ready to type "gmake" -afterwards. - - -You may also invoke gmake with the following options (the PREFIX can be set -in the yhttpd configurator which will be launched by the top configure script -or gmake config): - - gmake or gmake all (compiles everything, also modules) - gmake base (only compiles the base) - gmake base_start (only compiles the base and starts the server) - gmake clean (cleans everything) - gmake clean_base (only cleans the base obj and rpo files) - gmake clean_modules (only cleans the modules .so files) - gmake config (runs yhttpd configurator) - gmake deinstall (deinstalls yhttpd from PREFIX) - gmake gpl (shows the GNU General Public License) - gmake help (shows all available yhttpd gmake targets) - gmake install (installs yhttpd to PREFIX) - gmake modules (only compiles modules) - gmake mrproper (same as gmake clean plus removing all temp files) - gmake setup (runs all configure scripts and afterwards gmake all) - gmake start (compiles everything and starts the server) - gmake stats (generates yhttpd statistics) - gmake uninstall (same as deinstall) - gmake version (shows the current version of yhttpd) - -Example: "gmake all install clean" compiles everything, installs it to PREFIX -and cleans the source directories. - -Now its time to run the server with ./bin/yhttpd. - -Aferwards point your webbrowser to http://yourip:port ! +hmap.cpp - The hash map implementation which is a very fast data + structure. is needed for saving users, rooms and so on. -... have fun :-). +main.cpp - This includes the required manager headers for starting + the server and finally regulates the correct starting. -1.3.2 INSTALLATION QUICK START: +modl.cpp - The module loader. Stores pointers of all dynamic loaded + yChat modules in a hash map object and loads new modules + if desired or returns their pointers. -If you in hury, then you may just type gmake setup. In the yhttpd configurator -you may just choose all the default values. If done, yhttpd will get compiled -and is ready to run with ./bin/yhttpd! +pool.cpp - The implementation of the thread pool. all threads are stored + in a queue. Each thread will be reused if the assigned job is + finished. +reqp.cpp - This class implements the http request parser. If a client + starts a request to the server the reqp class will be + invoked. -1.4.0 HOW TO USE SCREEN WITH YHTTPD: +room.cpp - Specifies a chat room. For each chat room an instance of + this class exists. -If you are running yhttpd in ncurses mode you might want to install -the tool which is called "screen". This will enable you putting the -ncurses interface into the background, closing the terminal session -and reusing the interface later through another terminal. +thrd.cpp - This class is needed by sock.cpp while creating a POSIX thread. + All data which a thread needs to do its tasks are stored in a + thrd object and then a pointer to it will be passed to the + POSIX thread function. -Just do: - - screen -S yhttpd ./bin/yhttpd ( creates a new session and starts yhttpd in it ) - ctrl+d+a ( will detach the yhttpd session ) - ( closing the terminal ) - ( opening a new terminal ) - screen -r yhttpd ( will return you to the yhttpd process ) +user.cpp - Specifies a chat user. For each chat user an instance of + this class exists. -Screen will terminate automaticaly if all processes in its sessions are -terminated. +Abstract classes: -For a closer look read the screen manual page ( man screen ). +cont.cpp - All classes which need to store "key - value" data sets + inherit from this class. ( cont for content ). -1.5.0 CUSTOMIZATION: +name.cpp - All classes which own a private member string name inherit + from this class. It also provides public get_name and + set_name methods. + +As described ( main.cpp ), there are so called managers. Managers are +accessible through their assigned wrapper classes and may be +instanciated only once. + +chat.cpp - The chat manager. Is responsible for managing the internal + data structure of the system and also covers a lot of + important methods of the system. + +conf.cpp - The config manager. Parses the config file specified in + glob.h and stores all the values of it in a map. -If you like to customize the design/layout/language of yhttpd, you will have -to edit src/msgs.h and src/glob.h before you compile the sources. Afterwards -you can change the html-template files which are placed in the html/ -subdirectory and the language-templates which are placed in the XML config -file (etc/yhttpd.conf). +html.cpp - The html-template manager. Reads the requested html-template + files, stores them in an internal cache ( averts reading + template-files from hd twice or more ) and parses the + partivular template in order to substituate dynamic values + of it. -Notice, that you dont have to edit the src/glob.h file by hand any more, its -already done by the top ./configure script for you. +mutx.cpp - The mutex manager. Contains all global mutex handlers for + synchronizing POSIX thread shared data. until now only the + stdout is synchronized by mutx.cpp because most of objects + use their own mutex'. -You can edit the etc/yhttpd.conf to fit your needs. If you dont want to change -the config file, then you also can use yhttpd start parameters. +sock.cpp - The socket manager. Manages the socket connections. There + are multiplexed sockets. For each requests a new POSIX thread + will be created. -Exmpl: ./bin/yhttpd -o chat.database.password secretpassword +Files with a leading s_ contain static C++ classes -You can also use multiple words for a specific option. +s_chat.cpp - Static wrapper for the dynamic chat class. holds one global + reachable instance of chat until the program shuts down. -Exmpl: ./bin/yhttpd -o yhttpd.version "word1 word2 word3" +s_conf.cpp - Static wrapper for the dynamic conf class. holds one global + reachable instance of conf until the program shuts down. -will overwrite the default database password value of the yhttpd.conf. You can -do this with every configuration element by adding several -o option value -arguments to the start command. +s_html.cpp - Static wrapper for the dynamic html class. holds one global + reachable instance of conf until the program shuts down. -Dynamic loadable modules can be found in the mods/ subdirectory. (chat -commands are realized through modules too). Sources of modules can be found -in src/mods instead. If you want to create a new module just create a new -.cpp file and run in src/mods the ./configure script again. Next time -you run gmake your new module gets compiled. +s_mutx.cpp - Static wrapper for the dynamic mutx class. holds one global + reachable instance of conf until the program shuts down. -All messages defined in the msgs.h file contain server messages only ( a chat -user never wont read them, only the administrator will get to see them ). +s_sock.cpp - Static wrapper for the dynamic sock class. holds one global + reachable instance of conf until the program shuts down. -1.6.0 FILES: +s_tool.cpp - Static class which includes some usefull global reachable + methods which are not integraded in independent classes. -etc/yhttpd.conf - The yhttpd configuration file -html/* - The html template files -src/* - The yhttpd base sources -src/mods/* - The dynamic loadable modules sources -scripts/* - Some nice scripts needed for building & co. +Special header files ( all other header files which are not listed here +belong to their respective .cpp files ): -The following is created by building yhttpd: -obj/* - The object files of the compiled yhttpd base -mods/* - The compiled dynamic loadable modules -bin/yhttpd - The yhttpd binary (linked by the object files) +glob.h - Defines global variables which are known by compilation + time. -Customizable source files (if changed you need to run gmake clean all) -src/glob.h - Contains some global building options -src/msgs.h - Defines some server side messages +incl.h - This file is included from every other header file and + includes a set of headers which every class should be able + to use. +msgs.h - Defines console output messages for verbosity level 0 ( see + glob.h for setting up verbosity levels ). and also defines + all the system messages. you may edit this file for translating + the system user language. + +The basic class structure: + + base<room> base<user> + | | name + | | / \ + | | / \ + chat room user + + cont + / \ + / \ +conf html 1.7 WRITING BUG REPORTS How to submit a good bug report? -Send them to Bug@yhttpd.org. +Send them to Bug@yChat.org. First you should give the following information: -- yhttpd version, if CVS (or devel. tarball) then which day? +- yChat version, if CVS (or devel. tarball) then which day? - operating system / distribution and it's version - when did it crash? did you do something? can you reproduce the crash? -Getting backtrace of the crash also helps a lot, especially if yhttpd crashes -randomly. If after crash you see text: +Getting backtrace of the crash also helps a lot, especially if yChat crashes randomly. If after crash you see text: "segmentation fault (core dumped)" -It writes a file named "core" or "yhttpd.core" depending on your OS to directory -where you started yhttpd. If it doesn't print the "(core dumped)" or you can't -find the core file, you'll have to raise the limit for max. core file size -before running yhttpd. To do this, say: +It writes a file named "core" or "ychat.core" depending on your OS to directory where you started yChat. If it doesn't print the "(core dumped)" or you can't find the core file, you'll have to raise the limit for max. core file size before running yChat. To do this, say: ulimit -c unlimited -So, if you have the core file and GNU debugger (gdb), you can get the -backtrace with: +So, if you have the core file and GNU debugger (gdb), you can get the backtrace with: - gdb ./bin/yhttpd yhttpd.core + gdb ychat core bt Paste all the lines starting from line having #0 at the beginning. Here's an example session: - in reqp::parse(thrd*, std::string, std::map<std::string, std::string, - std::less<std::string>, std::allocator<std::pair<std::string const, std::string> > >&) () + in reqp::parse(thrd*, std::string, std::map<std::string, std::string, std::less<std::string>, std::allocator<std::pair<std::string const, std::string> > >&) () (gdb) bt - #0 0x0805c287 in reqp::parse(thrd*, std::string, std::map<std::string, - std::string, std::less<std::string>, std::allocator<std::pair<std::string - const, std::string> > >&) () + #0 0x0805c287 in reqp::parse(thrd*, std::string, std::map<std::string, std::string, std::less<std::string>, std::allocator<std::pair<std::string const, std::string> > >&) () #1 0x0806060f in sock::read_write(thrd*, int) () #2 0x080612ba in thrd::run() () #3 0x0805a3b8 in pool::run_func(void*) () @@ -264,29 +237,20 @@ Here's an example session: #5 0x281d44ae in _thread_start () from /usr/lib/libc_r.so.5 (gdb) -If you dont get such a gdb output, you need to recompile the yhttpd using -debuggig symbols. You can do it this way: - -cd yhttpd -gmake mrproper -./configure -g3 -ggdb -gmake start - 1.8 CONTACT: You may contact us through the following addresses: - Homepage - The yhttpd homepage is located at http://www.yhttpd.org + The yChat homepage is located at http://www.yChat.org - E-Mail - Paul C. Buetow: Snooper at yhttpd point org ( core developer ) - Volker Richter: Rover at yhttpd dot org ( core developer ) - Mail at yhttpd dot org ( reaches everybody of yhttpd ) + Paul C. Buetow: Snooper@yChat.org ( core developer ) + Volker Richter: Rover@yChat.org ( core developer ) + Mail@yChat.org ( reaches everybody of yChat ) - ICQ Paul C. Buetow: 11655527 - IRC - #Ychat and #Coding at irc.german-elite.net - + #ychat at irc.german-elite.net |