Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/usability/src/orxonox/ChatHistory.cc @ 9175

Last change on this file since 9175 was 7284, checked in by landauf, 14 years ago

merged consolecommands3 branch back to trunk.

note: the console command interface has changed completely, but the documentation is not yet up to date. just copy an existing command and change it to your needs, it's pretty self-explanatory. also the include files related to console commands are now located in core/command/. in the game it should work exactly like before, except for some changes in the auto-completion.

  • Property svn:eol-style set to native
File size: 5.0 KB
Line 
1/*
2 *   ORXONOX - the hottest 3D action shooter ever to exist
3 *                    > www.orxonox.net <
4 *
5 *
6 *   License notice:
7 *
8 *   This program is free software; you can redistribute it and/or
9 *   modify it under the terms of the GNU General Public License
10 *   as published by the Free Software Foundation; either version 2
11 *   of the License, or (at your option) any later version.
12 *
13 *   This program is distributed in the hope that it will be useful,
14 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
15 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 *   GNU General Public License for more details.
17 *
18 *   You should have received a copy of the GNU General Public License
19 *   along with this program; if not, write to the Free Software
20 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
21 *
22 *   Author:
23 *      Sandro 'smerkli' Merkli
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29#include "ChatHistory.h"
30#include "util/ScopedSingletonManager.h"
31
32#ifndef CHATTEST
33namespace orxonox
34{
35  /* singleton */
36  ManageScopedSingleton( ChatHistory, ScopeID::Root, false );
37#endif
38
39  /* constructor */
40#ifndef CHATTEST
41  //ChatHistory::ChatHistory( BaseObject* creator ) : BaseObject(creator)
42  ChatHistory::ChatHistory()
43#else
44  ChatHistory::ChatHistory()
45#endif
46  {
47    /* register the object */
48#ifndef CHATTEST
49    RegisterObject(ChatHistory);
50#endif
51
52    this->hist_log_enabled = true;
53
54    /* Read setting for logfiles */
55    if( hist_log_enabled ) /* NOTE Make this a check for the logfile setting */
56    { this->chat_hist_openlog();
57
58      /* push starting line */
59      this->chat_hist_logline( "--- Logfile opened ---" );
60    }
61
62    /* Read setting for maximum number of lines and set limit */
63    this->hist_maxlines = 200; /* NOTE to be changed, 200 is just for testing */
64  }
65
66  /* destructor */
67  ChatHistory::~ChatHistory()
68  {
69    chat_hist_closelog();
70
71    /* clear list */
72    this->hist_buffer.clear();
73  }
74
75  /* react to incoming chat */
76  void ChatHistory::incomingChat(const std::string& message,
77    unsigned int senderID)
78  {
79    /* --> a) look up the actual name of the sender */
80    std::string text;
81
82#ifndef CHATTEST
83    /* get sender ID and prepend it to the message */
84    if (senderID != CLIENTID_UNKNOWN)
85    {
86      /* if we can't find anything, use "unknown" as default */
87      std::string name = "unknown";
88
89      PlayerInfo* player = PlayerManager::getInstance().getClient(senderID);
90      if (player)
91        name = player->getName();
92
93      text = name + ": " + message;
94    }
95    else
96      text = message;
97#else
98    text = message;
99#endif
100
101    /* add the line to the history */
102    this->chat_hist_addline( text );
103
104    /* add the line to the log */
105    this->chat_hist_logline( text );
106  }
107
108  /* Synchronize logfile onto the hard drive */ /* MARK MARK */
109  int ChatHistory::syncLog()
110  {
111    //if( this->hist_logfile )
112      //this->hist_logfile.sync();
113    return 0;
114  }
115
116  /* add a line to this history */
117  int ChatHistory::chat_hist_addline( const std::string& toadd )
118  {
119    /* crop history at the end if it's too large */
120    while( this->hist_buffer.size() > this->hist_maxlines+1 )
121      this->hist_buffer.pop_front();
122
123    /* push to the front of the history */
124    this->hist_buffer.push_back( toadd );
125    return 0;
126  }
127
128  /* log a line to a logfile */
129  int ChatHistory::chat_hist_logline( const std::string& toadd )
130  {
131    /* output the line to the file if logging is enabled */
132    if( this->hist_log_enabled )
133      this->hist_logfile << toadd << std::endl;
134    return 0;
135  }
136
137  /* open logfile */
138  int ChatHistory::chat_hist_openlog()
139  {
140    /* TODO: find out the name of the file to log to via settings
141     *       and set the this->hist_logfile_path variable to it
142     */
143#ifndef CHATTEST
144    this->hist_logfile.open( (PathConfig::getInstance().getLogPathString() +
145      "chatlog.log").c_str(),
146      std::fstream::out | std::fstream::app );
147#else
148    this->hist_logfile.open( "/tmp/chatlog.log",
149      std::fstream::out | std::fstream::app );
150#endif
151
152    /* TODO check whether this works (not sure how you'd like it?) */
153    if( !this->hist_logfile )
154    { this->hist_log_enabled = false;
155#ifndef CHATTEST
156      COUT(2) << "Warning: Could not open logfile." << std::endl;
157#endif
158    }
159
160    /* if it worked */
161    return 0;
162  }
163
164  /* close logfile */
165  void ChatHistory::chat_hist_closelog()
166  {
167    /* see if we've actually got a logfile */
168    if( this->hist_logfile )
169    {
170      /* yes, we've got one, add a line that shows we're closing it */
171      this->chat_hist_logline( "--- Logfile closed ---" );
172
173      /* actually close down the file */
174      this->hist_logfile.close();
175    }
176  }
177
178  /* output history for debugging */
179  void ChatHistory::debug_printhist()
180  {
181    /* create deque iterator */
182    std::deque<std::string>::iterator it;
183
184    /* output all the strings */
185    for( it = this->hist_buffer.begin(); it != this->hist_buffer.end();
186      ++it )
187      std::cout << *it << std::endl;
188
189    /* output size */
190    std::cout << "Size: " << hist_buffer.size() << std::endl;
191  }
192
193#ifndef CHATTEST
194}
195#endif
Note: See TracBrowser for help on using the repository browser.