Blinker

@@ -9,13 +9,24 @@

       An operator connection is used to submit a movie number

       (prefixed with a star and followed by ahash, e.g. <code>*123#</code>).

       The movie with this number will then be played until another

-      number is requested or the connection is closed.

+      number is requested or the connection is closed (either by the

+      remote side or using <code>*#</code>).

     </p>

     <h2>Configuration</h2>

     <p>

       The configuration of the loveletter module with name <code>NAME</code>

       is located in the <code>loveletters/NAME</code> subdirectory.

     </p>

+    <h3>Sound File</h3>

+    <p>

+      While an operator is connected to the loveletter module (e.g. via

+      a phone connection), a sound file can be requested to be played.

+      (In case of the phone connection, this file is located on the

+      phone server.)

+      The name of the sound to request is contained in the file

+      <code>sound</code>.

+      If this file does not exists, no sound is requested to be played.

+    </p>

     <h3>Movies</h3>

     <p>

       The movies available for on-demand play are located in the subdirectory

@@ -0,0 +1 @@

+ondemand.alaw

@@ -18,6 +18,7 @@

 #include "LoveletterMovie.h"

 #include "Mgrs.h"

 #include "Module.h"

+#include "NameFile.h"

 #include "OutStreamFile.h"

 #include "StreamRecv.h"

 #include "Time.h"

@@ -34,6 +35,7 @@ namespace Blinker {

 Loveletter::Loveletter(const std::string &name, Mgrs &mgrs,

                const Directory &dirBase):

   Module(name, mgrs, dirBase),

+  m_fileSound(dirBase.getFile("sound")),

   m_fileOutStream(dirBase.getFile("outstream"), mgrs.m_streamMgr),

   m_fileHaltStream(dirBase.getFile("haltstream"), mgrs.m_streamMgr),

   m_movieTracker(*this, dirBase.getSubdir("movies")),

@@ -42,7 +44,8 @@ Loveletter::Loveletter(const std::string &name, Mgrs &mgrs,

   m_curFrame(0),

   m_curChange(false),

   m_halted(false),

-  m_pOpConn(NULL)

+  m_pOpConn(NULL),

+  m_sendPlay(false)

 {

   // load movies

   m_fileHaltStream.setStreamRecv(this);

@@ -71,6 +74,10 @@ Loveletter::~Loveletter()

 /// check for update of configuration

 void Loveletter::updateConfig()

 {

+  // sound name file was modified -> re-read sound name

+  if (m_fileSound.checkModified())

+    m_fileSound.update();

+

   // output stream name file was modified -> re-get output stream

   if (m_fileOutStream.checkModified()) {

     m_fileOutStream.update();

@@ -126,6 +133,13 @@ void Loveletter::setFrame(const std::string &stream, stBlinkenFrame *pFrame)

 /// callback when requested time reached

 void Loveletter::timeCall()

 {

+  // send sound play request on operator connection

+  if (m_sendPlay) {

+    m_sendPlay = false;

+    if (m_pOpConn && m_fileSound.m_valid)

+      m_pOpConn->sendPlay(m_fileSound.m_obj.m_str);

+  }

+

   // leave if halted

   if (m_halted)

     return;

@@ -160,11 +174,15 @@ bool Loveletter::acceptNewOpConn(const std::string &name)

  * @brief new operator connection

  * @param[in] name operator interface name

  * @param[in] pConn operator connection object

+ *

+ * The new connection may not yet be used for sending inside this callback.

  */

 void Loveletter::newOpConn(const std::string &name, OpConn *pConn)

 {

   closeOpConn(); // close old connection (to be on the safe side)

   m_pOpConn = pConn; // remember new connection

+  m_sendPlay = true; // schedule sending play request

+  m_mgrs.m_callMgr.requestTimeCall(this, Time::now());

   (void)name; // unused

 }

@@ -193,8 +211,11 @@ void Loveletter::opConnRecvKey(OpConn *pConn, char key)

     case '9':

       m_movieNumber += key;

       break;

-    // play movie

+    // exit / play movie

     case '#':

+      if (m_movieNumber.empty())

+        closeOpConn();

+      else

         startPlaying();

       break;

   }

@@ -216,6 +237,8 @@ void Loveletter::opConnRecvPlay(OpConn *pConn, const std::string &sound)

 /**

  * @brief operator connection is closed

  * @param[in] pConn operator connection object

+ *

+ * The connection may not be used for sending any more in this callback.

  */

 void Loveletter::opConnClose(OpConn *pConn)

 {

@@ -18,6 +18,7 @@

 #include "ListTracker.h"

 #include "Mgrs.h"

 #include "Module.h"

+#include "NameFile.h"

 #include "OpConn.h"

 #include "OpConnIf.h"

 #include "OpReqIf.h"

@@ -89,6 +90,8 @@ public:

    * @brief new operator connection

    * @param[in] name operator interface name

    * @param[in] pConn operator connection object

+   *

+   * The new connection may not yet be used for sending inside this callback.

    */

   virtual void newOpConn(const std::string &name, OpConn *pConn);

@@ -109,6 +112,8 @@ public:

   /**

    * @brief operator connection is closed

    * @param[in] pConn operator connection object

+   *

+   * The connection may not be used for sending any more in this callback.

    */

   virtual void opConnClose(OpConn *pConn);

@@ -132,6 +137,7 @@ protected:

   void stopPlaying();

 protected:

+  NameFile      m_fileSound;      ///< file containing sound name

   OutStreamFile m_fileOutStream;  ///< output stream name file

   InStreamFile  m_fileHaltStream; /**< halt stream name file

                                        (playing halts if stream active) */

@@ -147,6 +153,7 @@ protected:

   Time          m_nextTime;       /**< when to show next frame

                                        (valid if m_curValid && !m_halted) */

   OpConn        *m_pOpConn;       ///< current operator connection or NULL

+  bool          m_sendPlay;       ///< if sending play request needed

   std::string   m_movieNumber;    ///< number of movie to play

 }; // class Loveletter

@@ -40,6 +40,8 @@ public:

   /**

    * @brief operator connection is closed

    * @param[in] pConn operator connection object

+   *

+   * The connection may not be used for sending any more in this callback.

    */

   virtual void opConnClose(OpConn *pConn) = 0;

 }; // class OpConnIf

@@ -67,6 +67,8 @@ bool OpPrinter::acceptNewOpConn(const std::string &name)

  * @brief new operator connection

  * @param[in] name operator interface name

  * @param[in] pConn operator connection object

+ *

+ * The new connection may not yet be used for sending inside this callback.

  */

 void OpPrinter::newOpConn(const std::string &name, OpConn *pConn)

 {

@@ -106,6 +108,8 @@ void OpPrinter::opConnRecvPlay(OpConn *pConn, const std::string &sound)

 /**

  * @brief operator connection is closed

  * @param[in] pConn operator connection object

+ *

+ * The connection may not be used for sending any more in this callback.

  */

 void OpPrinter::opConnClose(OpConn *pConn)

 {

@@ -60,6 +60,8 @@ public:

    * @brief new operator connection

    * @param[in] name operator interface name

    * @param[in] pConn operator connection object

+   *

+   * The new connection may not yet be used for sending inside this callback.

    */

   virtual void newOpConn(const std::string &name, OpConn *pConn);

@@ -80,6 +82,8 @@ public:

   /**

    * @brief operator connection is closed

    * @param[in] pConn operator connection object

+   *

+   * The connection may not be used for sending any more in this callback.

    */

   virtual void opConnClose(OpConn *pConn);

@@ -36,6 +36,8 @@ public:

    * @brief new operator connection

    * @param[in] name operator interface name

    * @param[in] pConn operator connection object

+   *

+   * The new connection may not yet be used for sending inside this callback.

    */

   virtual void newOpConn(const std::string &name, OpConn *pConn) = 0;

 }; // class OpReqIf

@@ -8,6 +8,7 @@

 #include <map>

 #include <string>

+#include <vector>

 #include "Directory.h"

 #include "File.h"

@@ -46,6 +47,12 @@ protected:

   /// map from connection to line number

   typedef std::map<OpConn *, unsigned int> ConnLineMap;

+  /// type for command buffer (command sent before line connected)

+  typedef std::vector<std::string> CmdBuf;

+

+  /// type for command buffer map (line to command buffer)

+  typedef std::map<unsigned int, CmdBuf> CmdBufMap;

+

 public:

   /**

    * @brief constructor

@@ -101,6 +108,8 @@ public:

   /**

    * @brief operator connection is closed

    * @param[in] pConn operator connection object

+   *

+   * The connection may not be used for sending any more in this callback.

    */

   virtual void opConnClose(OpConn *pConn);

@@ -140,10 +149,24 @@ protected:

   void sendHangup(unsigned int line);

   /**

-   * @brief send message to server

+   * @brief send message buffered to server

+   * @param[in] line number of line to hangup

+   * @param[in] msg message to send

+   */

+  void sendBuf(unsigned int line, const std::string &msg);

+

+  /**

+   * @brief send message to server now

+   * @param[in] line number of line to hangup

+   * @param[in] msg message to send

+   */

+  void sendNow(unsigned int line, const std::string &msg);

+

+  /**

+   * @brief send message to socket

    * @param[in] msg message to send

    */

-  void send(const std::string &msg);

+  void sendSock(const std::string &msg);

   /// receive data from socket

   void receiveFromSock();

@@ -161,6 +184,12 @@ protected:

    */

   void incomingCall(unsigned int line, const std::string &extension);

+  /**

+   * @brief phone line connected

+   * @param[in] line number of phone line

+   */

+  void connected(unsigned int line);

+

   /**

    * @brief hangup on phone line

    * @param[in] line number of phone line

@@ -207,6 +236,7 @@ protected:

   ExtMap         m_extMap;         ///< map of extensions to call

   LineConnMap    m_lineConnMap;    ///< map from line number to connection

   ConnLineMap    m_connLineMap;    ///< map from connection to line number

+  CmdBufMap      m_cmdBufMap;      ///< commands to send after line connected

 }; // class Phone

 } // namespace Blinker

@@ -6,8 +6,10 @@

 #ifndef BLINKER_PHONE_IMPL_H

 #define BLINKER_PHONE_IMPL_H

+#include <map>

 #include <sstream>

 #include <string>

+#include <vector>

 #include "Directory.h"

 #include "File.h"

@@ -164,6 +166,8 @@ void Phone<ADDR, SOCK>::opConnRecvPlay(OpConn *pConn, const std::string &sound)

 /**

  * @brief operator connection is closed

  * @param[in] pConn operator connection object

+ *

+ * The connection may not be used for sending any more in this callback.

  */

 template<typename ADDR, typename SOCK>

 void Phone<ADDR, SOCK>::opConnClose(OpConn *pConn)

@@ -179,6 +183,9 @@ void Phone<ADDR, SOCK>::opConnClose(OpConn *pConn)

   // remove connection from maps

   m_connLineMap.erase(pConn);

   m_lineConnMap.erase(line);

+

+  // remove command buffer for this line

+  m_cmdBufMap.erase(line);

 }

 /// (re-)read server address

@@ -242,7 +249,7 @@ void Phone<ADDR, SOCK>::destroySock()

 template<typename ADDR, typename SOCK>

 void Phone<ADDR, SOCK>::sendRegister()

 {

-  send("0:register");

+  sendNow(0, "register");

   // set time for next register message and next heartbeat

   m_timeRegister = Time::now() + m_serverTimeout;

@@ -254,7 +261,7 @@ void Phone<ADDR, SOCK>::sendRegister()

 template<typename ADDR, typename SOCK>

 void Phone<ADDR, SOCK>::sendHeartbeat()

 {

-  send("0:heartbeat");

+  sendNow(0, "heartbeat");

   // set time for next heartbeat

   m_timeHeartbeat = Time::now() + m_heartbeatInterval;

@@ -270,8 +277,8 @@ template<typename ADDR, typename SOCK>

 void Phone<ADDR, SOCK>::sendPlay(unsigned int line, const std::string &sound)

 {

   std::stringstream strm;

-  strm << line << ":playbackground:" << sound;

-  send(strm.str());

+  strm << "playbackground:" << sound;

+  sendBuf(line, strm.str());

 }

 /**

@@ -281,9 +288,7 @@ void Phone<ADDR, SOCK>::sendPlay(unsigned int line, const std::string &sound)

 template<typename ADDR, typename SOCK>

 void Phone<ADDR, SOCK>::sendHangup(unsigned int line)

 {

-  std::stringstream strm;

-  strm << line << ":hangup";

-  send(strm.str());

+  sendNow(line, "hangup");

 }

 /**

@@ -292,18 +297,47 @@ void Phone<ADDR, SOCK>::sendHangup(unsigned int line)

  */

 template<typename ADDR, typename SOCK>

 void Phone<ADDR, SOCK>::sendAccept(unsigned int line)

+{

+  sendNow(line, "accept");

+}

+

+/**

+ * @brief send message buffered to server

+ * @param[in] line number of line to hangup

+ * @param[in] msg message to send

+ */

+template<typename ADDR, typename SOCK>

+void Phone<ADDR, SOCK>::sendBuf(unsigned int line, const std::string &msg)

+{

+  CmdBufMap::iterator itCmdBuf = m_cmdBufMap.find(line);

+  // line not yet connected -> buffer command

+  if (itCmdBuf != m_cmdBufMap.end())

+    // buffer command

+    itCmdBuf->second.push_back(msg);

+  // line is connected -> send now

+  else

+    sendNow(line, msg);

+}

+

+/**

+ * @brief send message to server now

+ * @param[in] line number of line to hangup

+ * @param[in] msg message to send

+ */

+template<typename ADDR, typename SOCK>

+void Phone<ADDR, SOCK>::sendNow(unsigned int line, const std::string &msg)

 {

   std::stringstream strm;

-  strm << line << ":accept";

-  send(strm.str());

+  strm << line << ":" << msg;

+  sendSock(strm.str());

 }

 /**

- * @brief send message to server

+ * @brief send message to socket

  * @param[in] msg message to send

  */

 template<typename ADDR, typename SOCK>

-void Phone<ADDR, SOCK>::send(const std::string &msg)

+void Phone<ADDR, SOCK>::sendSock(const std::string &msg)

 {

   // check that there is a socket and a server address

   if (!m_pSock || !m_fileServer.m_valid)

@@ -354,6 +388,8 @@ void Phone<ADDR, SOCK>::serverMsg(const std::string &msg)

   if (!parser.uintNo(line) || !parser.fixChr(':') ||

       !parser.untilDelim(":", false, cmd))

     return;

+  if (line < 1) // we are only interested in real lines here

+    return;

   // incoming call

   if (cmd == "setup") {

@@ -364,6 +400,11 @@ void Phone<ADDR, SOCK>::serverMsg(const std::string &msg)

     incomingCall(line, extension);

   }

+  // call connected

+  else if (cmd == "connected") {

+    connected(line);

+  }

+

   // hangup

   else if (cmd == "onhook") {

     hangup(line);

@@ -390,6 +431,10 @@ void Phone<ADDR, SOCK>::incomingCall(unsigned int line,

   // hangup old call on this line (to be on the safe side)

   hangup(line);

+  // buffer further commands to be sent to this line until it is connected

+  // -> create command buffer for this line

+  m_cmdBufMap[line];

+

   // lookup extension

   ExtMap::iterator itExt = m_extMap.find(extension);

   if (itExt == m_extMap.end())

@@ -408,6 +453,28 @@ void Phone<ADDR, SOCK>::incomingCall(unsigned int line,

   sendAccept(line);

 }

+/**

+ * @brief phone line connected

+ * @param[in] line number of phone line

+ */

+template<typename ADDR, typename SOCK>

+void Phone<ADDR, SOCK>::connected(unsigned int line)

+{

+  // get buffered commands for this line

+  CmdBuf &cmdBuf = m_cmdBufMap[line];

+

+  // send buffered commands now

+  for (CmdBuf::const_iterator cmd = cmdBuf.begin();

+       cmd != cmdBuf.end(); ++cmd) {

+    std::stringstream strm;

+    strm << line << ":" << *cmd;

+    sendSock(strm.str());

+  }

+

+  // delete command buffer for this line

+  m_cmdBufMap.erase(line);

+}

+

 /**

  * @brief hangup on phone line

  * @param[in] line number of phone line

@@ -426,6 +493,9 @@ void Phone<ADDR, SOCK>::hangup(unsigned int line)

   // remove connection from maps

   m_lineConnMap.erase(line);

   m_connLineMap.erase(pConn);

+

+  // remove command buffer for this line

+  m_cmdBufMap.erase(line);

 }

 /**