* updated license headers

* updated documentation

1 files changed, 123 insertions, 165 deletions

diff --git a/AudioManagerDaemon/src/CAmTelnetServer.cpp b/AudioManagerDaemon/src/CAmTelnetServer.cpp
index 1274a8d..079e6e3 100644
--- a/AudioManagerDaemon/src/CAmTelnetServer.cpp
+++ b/AudioManagerDaemon/src/CAmTelnetServer.cpp
@@ -1,24 +1,23 @@
 /**
- * Copyright (C) 2011, BMW AG
+ * Copyright (C) 2012, GENIVI Alliance, Inc.
+ * Copyright (C) 2012, BMW AG
  *
- * GeniviAudioMananger AudioManagerDaemon
+ * This file is part of GENIVI Project AudioManager.
  *
- * \file CAmTelnetServer.cpp
+ * Contributions are licensed to the GENIVI Alliance under one or more
+ * Contribution License Agreements.
+ *
+ * \copyright
+ * This Source Code Form is subject to the terms of the
+ * Mozilla Public License, v. 2.0. If a  copy of the MPL was not distributed with
+ * this file, You can obtain one at http://mozilla.org/MPL/2.0/.
  *
- * \date 20-Oct-2011 3:42:04 PM
- * \author Christian Mueller (christian.ei.mueller@bmw.de)
  *
- * \section License
- * GNU Lesser General Public License, version 2.1, with special exception (GENIVI clause)
- * Copyright (C) 2011, BMW AG Christian Mueller  Christian.ei.mueller@bmw.de
+ * \author Christian Mueller, christian.ei.mueller@bmw.de BMW 2011,2012
+ * \author Frank Herchet, frank.fh.herchet@bmw.de BMW 2012
  *
- * This program is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License, version 2.1, as published by the Free Software Foundation.
- * 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, version 2.1, for more details.
- * You should have received a copy of the GNU Lesser General Public License, version 2.1, along with this program; if not, see <http://www.gnu.org/licenses/lgpl-2.1.html>.
- * Note that the copyright holders assume that the GNU Lesser General Public License, version 2.1, may also be applicable to programs even in cases in which the program is not a library in the technical sense.
- * Linking AudioManager statically or dynamically with other modules is making a combined work based on AudioManager. You may license such other modules under the GNU Lesser General Public License, version 2.1. If you do not want to license your linked modules under the GNU Lesser General Public License, version 2.1, you may use the program under the following exception.
- * As a special exception, the copyright holders of AudioManager give you permission to combine AudioManager with software programs or libraries that are released under any license unless such a combination is not permitted by the license of such a software program or library. You may copy and distribute such a system following the terms of the GNU Lesser General Public License, version 2.1, including this special exception, for AudioManager and the licenses of the other code concerned.
- * Note that people who make modified versions of AudioManager are not obligated to grant this special exception for their modified versions; it is their choice whether to do so. The GNU Lesser General Public License, version 2.1, gives permission to release a modified version without this exception; this exception also makes it possible to release a modified version which carries forward this exception.
+ * \file CAmTelnetServer.cpp
+ * For further information see http://www.genivi.org/.
  *
  */
 
@@ -37,78 +36,61 @@
 #include <iterator>
 #include "CAmDatabaseHandler.h"
 #include "CAmRoutingSender.h"
-#include "shared/CAmDltWrapper.h"
 #include "CAmTelnetMenuHelper.h"
+#include "shared/CAmDltWrapper.h"
 
-namespace am {
+namespace am
+{
 
-CAmTelnetServer* CAmTelnetServer::instance = NULL;
+CAmTelnetServer* CAmTelnetServer::mpInstance = NULL;
 
 #define PRINT_BOOL(var) var ? output+="true\t\t" : output+="false\t\t";
 
-CAmTelnetServer::CAmTelnetServer(CAmSocketHandler *iSocketHandler, CAmCommandSender *iCommandSender, CAmCommandReceiver *iCommandReceiver, CAmRoutingSender *iRoutingSender, CAmRoutingReceiver *iRoutingReceiver, CAmControlSender *iControlSender, CAmControlReceiver *iControlReceiver, CAmDatabaseHandler *iDatabasehandler, CAmRouter *iRouter, unsigned int servPort, unsigned int maxConnections)
-   :telnetConnectFiredCB(this,&CAmTelnetServer::connectSocket),
-   telnetReceiveFiredCB(this,&CAmTelnetServer::receiveData),
-   telnetDispatchCB(this,&CAmTelnetServer::dispatchData),
-   telnetCheckCB(this,&CAmTelnetServer::check),
-   mSocketHandler(iSocketHandler),
-   mCommandSender(iCommandSender),
-   mCommandReceiver(iCommandReceiver),
-   mRoutingSender(iRoutingSender),
-   mRoutingReceiver(iRoutingReceiver),
-   mControlSender(iControlSender),
-   mControlReceiver(iControlReceiver),
-   mDatabasehandler(iDatabasehandler),
-   mRouter(iRouter),
-   mConnecthandle(),
-   mMsgList(),
-   mListConnections(),
-   mConnectFD(NULL),
-   mServerPort(servPort),
-   mMaxConnections(maxConnections),
-   mTelnetMenuHelper(iSocketHandler,iCommandSender,iCommandReceiver,iRoutingSender,iRoutingReceiver,iControlSender,iControlReceiver,iDatabasehandler,iRouter,this)
+CAmTelnetServer::CAmTelnetServer(CAmSocketHandler *iSocketHandler, CAmCommandSender *iCommandSender, CAmCommandReceiver *iCommandReceiver, CAmRoutingSender *iRoutingSender, CAmRoutingReceiver *iRoutingReceiver, CAmControlSender *iControlSender, CAmControlReceiver *iControlReceiver, CAmDatabaseHandler *iDatabasehandler, CAmRouter *iRouter, unsigned int servPort, unsigned int maxConnections) :
+        telnetConnectFiredCB(this, &CAmTelnetServer::connectSocket), telnetReceiveFiredCB(this, &CAmTelnetServer::receiveData), telnetDispatchCB(this, &CAmTelnetServer::dispatchData), telnetCheckCB(this, &CAmTelnetServer::check), mpSocketHandler(iSocketHandler), mpCommandSender(iCommandSender), mpCommandReceiver(iCommandReceiver), mpRoutingSender(iRoutingSender), mpRoutingReceiver(iRoutingReceiver), mpControlSender(iControlSender), mpControlReceiver(iControlReceiver), mpDatabasehandler(iDatabasehandler), mpRouter(iRouter), mConnecthandle(), mListMessages(), mListConnections(), mConnectFD(NULL), mServerPort(servPort), mMaxConnections(maxConnections), mTelnetMenuHelper(iSocketHandler, iCommandSender, iCommandReceiver, iRoutingSender, iRoutingReceiver, iControlSender, iControlReceiver,
+                iDatabasehandler, iRouter, this)
 {
-	assert(mSocketHandler!=NULL);
-	assert(mCommandReceiver!=NULL);
-	assert(mCommandSender!=NULL);
-	assert(mControlSender!=NULL);
-	assert(mControlReceiver!=NULL);
-	assert(mRoutingSender!=NULL);
-	assert(mRoutingReceiver!=NULL);
-	assert(mDatabasehandler!=NULL);
-	assert(mRouter!=NULL);
-	assert(servPort!=0);
-	assert(mMaxConnections!=0);
-
-	instance = this;
-	//mTelnetMenuHelper.setTelnetServer(this);
-
-	int yes = 1;
-	struct sockaddr_in servAddr;
+    assert(mpSocketHandler!=NULL);
+    assert(mpCommandReceiver!=NULL);
+    assert(mpCommandSender!=NULL);
+    assert(mpControlSender!=NULL);
+    assert(mpControlReceiver!=NULL);
+    assert(mpRoutingSender!=NULL);
+    assert(mpRoutingReceiver!=NULL);
+    assert(mpDatabasehandler!=NULL);
+    assert(mpRouter!=NULL);
+    assert(servPort!=0);
+    assert(mMaxConnections!=0);
+
+    mpInstance = this;
+    //mTelnetMenuHelper.setTelnetServer(this);
+
+    int yes = 1;
+    struct sockaddr_in servAddr;
 
     //setup the port Listener
     mConnectFD = socket(PF_INET, SOCK_STREAM, IPPROTO_TCP);
     setsockopt(mConnectFD, SOL_SOCKET, SO_REUSEADDR, &yes, sizeof(int));
     memset(&servAddr, 0, sizeof(servAddr));
-    servAddr.sin_family      = AF_INET;
+    servAddr.sin_family = AF_INET;
     servAddr.sin_addr.s_addr = INADDR_ANY;
-    servAddr.sin_port        = htons(servPort);
+    servAddr.sin_port = htons(servPort);
     bind(mConnectFD, (struct sockaddr *) &servAddr, sizeof(servAddr));
 
-    if (listen(mConnectFD,mMaxConnections) < 0)
+    if (listen(mConnectFD, mMaxConnections) < 0)
     {
-        logError("TelnetServer::TelnetServerk cannot listen ",errno);
+        logError("TelnetServer::TelnetServerk cannot listen ", errno);
     }
     else
         logInfo("TelnetServer::TelnetServer started listening on port", mServerPort);
 
-    int a=1;
-    ioctl (mConnectFD, FIONBIO, (char *) &a);
-    setsockopt (mConnectFD, SOL_SOCKET, SO_KEEPALIVE, (char *) &a, sizeof (a));
+    int a = 1;
+    ioctl(mConnectFD, FIONBIO, (char *) &a);
+    setsockopt(mConnectFD, SOL_SOCKET, SO_KEEPALIVE, (char *) &a, sizeof(a));
 
     short events = 0;
     events |= POLLIN;
-    mSocketHandler->addFDPoll(mConnectFD, events, NULL, &telnetConnectFiredCB, NULL, NULL, NULL, mConnecthandle);
+    mpSocketHandler->addFDPoll(mConnectFD, events, NULL, &telnetConnectFiredCB, NULL, NULL, NULL, mConnecthandle);
 }
 
 CAmTelnetServer::~CAmTelnetServer()
@@ -119,112 +101,95 @@ void CAmTelnetServer::connectSocket(const pollfd pfd, const sh_pollHandle_t hand
 {
     (void) handle;
     (void) userData;
-   //first, accept the connection, create a new filedescriptor
-	struct sockaddr answer;
-	socklen_t len=sizeof(answer);
-	connection_s connection;
-	connection.handle = 0;
-	connection.filedescriptor = accept(pfd.fd, (struct sockaddr*)&answer, &len);
-
-	// Notiy menuhelper
-	mTelnetMenuHelper.newSocketConnection(connection.filedescriptor);
-
-	//set the correct event:
-	short event = 0;
-	event |=POLLIN;
-
-	//aded the filedescriptor to the sockethandler and register the callbacks for receiving the data
-	mSocketHandler->addFDPoll(connection.filedescriptor,event,NULL,&telnetReceiveFiredCB,&telnetCheckCB,&telnetDispatchCB,NULL,connection.handle);
-	mListConnections.push_back(connection);
+    //first, accept the connection, create a new filedescriptor
+    struct sockaddr answer;
+    socklen_t len = sizeof(answer);
+    connection_s connection;
+    connection.handle = 0;
+    connection.filedescriptor = accept(pfd.fd, (struct sockaddr*) &answer, &len);
+
+    // Notiy menuhelper
+    mTelnetMenuHelper.newSocketConnection(connection.filedescriptor);
+
+    //set the correct event:
+    short event = 0;
+    event |= POLLIN;
+
+    //aded the filedescriptor to the sockethandler and register the callbacks for receiving the data
+    mpSocketHandler->addFDPoll(connection.filedescriptor, event, NULL, &telnetReceiveFiredCB, &telnetCheckCB, &telnetDispatchCB, NULL, connection.handle);
+    mListConnections.push_back(connection);
 }
 
 void CAmTelnetServer::disconnectClient(int filedescriptor)
 {
-   std::vector<connection_s>::iterator iter = mListConnections.begin();
-   while(iter != mListConnections.end())
-   {
-      if( filedescriptor == iter->filedescriptor )
-      {
-         if( E_OK == mSocketHandler->removeFDPoll(iter->handle))
-         {
-            mListConnections.erase(iter);
-            close(filedescriptor);
-         }
-         else
-         {
-            // TODO: Handle error
-         }
-
-         break;
-      }
-      iter++;
-   }
+    std::vector<connection_s>::iterator iter = mListConnections.begin();
+    while (iter != mListConnections.end())
+    {
+        if (filedescriptor == iter->filedescriptor)
+        {
+            if (E_OK == mpSocketHandler->removeFDPoll(iter->handle))
+            {
+                mListConnections.erase(iter);
+                close(filedescriptor);
+            }
+            else
+            {
+                // TODO: Handle error
+            }
+
+            break;
+        }
+        iter++;
+    }
 }
 
 void CAmTelnetServer::receiveData(const pollfd pollfd, const sh_pollHandle_t handle, void *userData)
 {
     (void) handle;
     (void) userData;
-	//initialize buffer
-	char buffer[100];
-	//read until buffer is full or no more data is there
-	int read=recv(pollfd.fd,buffer,100,NULL);
-	if (read>1)
-	{
-		//read the message and store it in a queue - its a telnet connection so data will be sent on enter !
-		std::string msg=std::string(buffer,read);
-		mMsgList.push(msg);
-	}
+    //initialize buffer
+    char buffer[100];
+    //read until buffer is full or no more data is there
+    int read = recv(pollfd.fd, buffer, 100, NULL);
+    if (read > 1)
+    {
+        //read the message and store it in a queue - its a telnet connection so data will be sent on enter !
+        std::string msg = std::string(buffer, read);
+        mListMessages.push(msg);
+    }
 }
 
 bool CAmTelnetServer::dispatchData(const sh_pollHandle_t handle, void *userData)
 {
     (void) userData;
-	std::vector<connection_s>::iterator iterator=mListConnections.begin();
-	for(;iterator!=mListConnections.end();++iterator)
-	{
-		if(iterator->handle==handle) break;
-	}
-	//if (iterator==mListConnections.end()) return false;
-
-	std::string command;
-	std::queue<std::string> MsgQueue;
-	if(!mMsgList.empty())
-	{
-	   sliceCommand(mMsgList.front(),command,MsgQueue);
-	   mMsgList.pop();
-	}
-
-	mTelnetMenuHelper.enterCmdQueue(MsgQueue,iterator->filedescriptor);
+    std::vector<connection_s>::iterator iterator = mListConnections.begin();
+    for (; iterator != mListConnections.end(); ++iterator)
+    {
+        if (iterator->handle == handle)
+            break;
+    }
 
-	// must return false to stop endless polling
-	return false;
+    std::string command;
+    std::queue<std::string> MsgQueue;
+    if (!mListMessages.empty())
+    {
+        sliceCommand(mListMessages.front(), command, MsgQueue);
+        mListMessages.pop();
+    }
 
-	/*
-	mMsgList.pop();
-	mMapCommand_t::iterator commandIter=mMapCommands.find(command);
-	if (commandIter==mMapCommands.end())
-	{
-		send(iterator->filedescriptor,"Command not found!\n",20,0);
-	}
-	else
-	{
-	   commandIter->second(msg,iterator->filedescriptor);
-		//(*commandIter).second(msg,iterator->filedescriptor);
-	}
+    mTelnetMenuHelper.enterCmdQueue(MsgQueue, iterator->filedescriptor);
 
-	//remove the message from the queue and return false if there is no more message to read.
-	if (mMsgList.size()!=0) return true;
-	return false;
-	*/
+    // must return false to stop endless polling
+    return (false);
 }
 
 bool CAmTelnetServer::check(const sh_pollHandle_t handle, void *userData)
 {
-    (void)handle;
-    (void)userData;
-    if (mMsgList.size() != 0) return true;
-    return false;
+    (void) handle;
+    (void) userData;
+    if (mListMessages.size() != 0)
+        return (true);
+    return (false);
 }
 
 void am::CAmTelnetServer::sliceCommand(const std::string & string, std::string & command, std::queue<std::string> & MsgQueue)
@@ -238,25 +203,18 @@ void am::CAmTelnetServer::sliceCommand(const std::string & string, std::string &
 
     int c = 0;
 
-    while(!endOfStream)
+    while (!endOfStream)
     {
-       cmd = *begin;
-       MsgQueue.push(cmd);
-       begin++;
-
-       if(begin == end )
-       {
-          endOfStream = true;
-       }
-       c++;
+        cmd = *begin;
+        MsgQueue.push(cmd);
+        begin++;
+
+        if (begin == end)
+        {
+            endOfStream = true;
+        }
+        c++;
     }
-
-
-    /*
-    command = *begin++;
-    msg = std::vector<std::string>(begin, end);
-    */
 }
 }
 
-