├── LICENSE.txt
├── chat.gif
├── chat.php
├── doc.html
├── index.html
├── readme.MD
├── scheme of chat.odg
└── scheme-of-chat.jpg


/LICENSE.txt:
--------------------------------------------------------------------------------
 1 | The MIT License (MIT)
 2 | 
 3 | Copyright (c) 2017 Trapenok Victor <Levhav@yandex.ru>
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in
13 | all copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21 | THE SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/chat.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/CppComet/php-chat-example/7e3fa283863c3ff73e1560caf99c7da876038b1a/chat.gif


--------------------------------------------------------------------------------
/chat.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | $host = "app.comet-server.ru";
 4 | $user = "15";
 5 | $password = "lPXBFPqNg3f661JcegBY0N0dPXqUBdHXqj2cHf04PZgLHxT6z55e20ozojvMRvB8";
 6 | 
 7 | $comet = mysqli_connect($host, $user, $password, "CometQL_v1");
 8 | 
 9 | if(mysqli_errno($comet))
10 | {
11 |     echo "Error:".mysqli_error($link);
12 | }
13 | 
14 | $msg = Array( "name" => $_POST["name"], "text"  => $_POST["text"] );
15 | $msg = json_encode($msg);
16 | $msg = mysqli_real_escape_string($comet, $msg);
17 | 
18 | $query = "INSERT INTO pipes_messages (name, event, message)" .
19 |   "VALUES('simplechat', 'newMessage', '".$msg."')";
20 |  
21 | mysqli_query($comet, $query); 
22 | 
23 | if(mysqli_errno($comet))
24 | {
25 |     echo "Error:".mysqli_error($comet);
26 | } 
27 | else
28 | {
29 |     echo "ok";
30 | }
31 | 


--------------------------------------------------------------------------------
/doc.html:
--------------------------------------------------------------------------------
  1 | <div style="margin: 20px auto;
  2 |     width: 970px;
  3 |     box-shadow: 0px 0px 10px 0px #ccc;
  4 |     padding: 20px;">
  5 | I want to tell you about my <a href="https://github.com/CppComet/comet-server">Open Source project of comet server</a>. It simplifies the process of creating chat and notifications for the site. 
  6 | 
  7 | The CppComet takes care of all the work of maintaining websocket connections and give simple api for sending messages from backend to frontend by websockets.
  8 | CppComet is written in C++ and can handle many simultaneous connections. Here are the <a href="https://comet-server.com/wiki/doku.php/en:comet:load-testing-result">results of load testing in 64,000 online connections</a> that I conducted.
  9 |  
 10 | <h3>Features</h3>
 11 | <ul>
 12 |   <li>Api for more then 9 languages. CometQL API allows you connect to comet server by mysql protocol.</li>
 13 |   <li>Supports users authenticating on the server</li>
 14 |   <li>Allow sending a private message to users</li>
 15 |   <li>Allows you to send public messages to users via channels</li>
 16 |   <li>Allows subscription from JavaScript to changing other user’s status</li>
 17 |   <li>Allows subscription to updates of online users list in real-time</li>
 18 |   <li>Sending messages to channel from JS</li>
 19 |   <li>Allows get information when users were online</li> 
 20 | </ul>
 21 |  
 22 | For testing CppComet without install on vps you can use free cloud service with same api. In the all examples I will use demonstration access from <a href="https://comet-server.com">comet-server.com</a> for those who could not or were too lazy to deploy the server on their vps.
 23 | 
 24 | Demo access credentials:
 25 | <code>Login: 15
 26 | Password:lPXBFPqNg3f661JcegBY0N0dPXqUBdHXqj2cHf04PZgLHxT6z55e20ozojvMRvB8
 27 | Host: app.comet-server.ru</code>
 28 | 
 29 | <h3>How it works</h3>
 30 | 
 31 | Comet technology – allows sending arbitrary messages to client through server initiative.
 32 | 
 33 | Browser opens page of your site. And after loading this page JavaScript Api establishes a persistent connection to CppComet using websockets. While page is open, your server can send text message to client. It appeals via CometQL API to CppComet and transfer message for browser.
 34 | 
 35 | <img src="https://github.com/CppComet/php-chat-example/raw/master/scheme-of-chat.jpg" alt="chat sheme" />
 36 | 
 37 | <ol>
 38 |   <li>Connecting to the comet server by websockets</li>
 39 |   <li>Send ajax message for add new massage to chat</li>
 40 |   <li>Send message to CppComet</li>
 41 |   <li>CppComet send messages for all subscribers in pipe (and JavaScript API delivers this message to your callback.)</li>
 42 |   <li>Add message to database (optional)</li>
 43 | </ol>
 44 | 
 45 | <h3>Chat example</h3>
 46 | 
 47 | <ul>
 48 |   <li><a href="https://github.com/CppComet/php-chat-example">Full code of this example in GitHub</a></li>
 49 |   <li><a href="https://jsfiddle.net/Levhav/o35kvmn2/21/">Live online demo</a></li>
 50 | </ul>
 51 | 
 52 | <img src="https://raw.githubusercontent.com/CppComet/php-chat-example/master/chat.gif" alt="result chat on gif" />
 53 | 
 54 | <h4><strong>Step 1. Connecting to the comet server</strong></h4>
 55 | 
 56 | Code in <a href="https://github.com/CppComet/php-chat-example/blob/master/index.html">file index.html</a>
 57 | 
 58 | To connect to the comet server from the JavaScript API, use the following command:
 59 | 
 60 | <pre>cometApi.start({node:"app.comet-server.ru", dev_id:15})</pre>
 61 | <ul>
 62 |   <li>in parameter node - set hostname of your own server</li>
 63 |   <li>parameter dev_id - use only if you use saas service comet-server.com</li>
 64 | </ul>
 65 | 
 66 | <h4><strong>Step 2. Send ajax message for add new massage to chat</strong></h4>
 67 | 
 68 | <pre>
 69 | var name = "my name";
 70 | var text = "my text message";
 71 | $.ajax({
 72 |    url: "https://comet-server.com/doc/CppComet/chat-example/chat.php",
 73 |    type: "POST", 
 74 |    data:"text="+encodeURIComponent(text)+"&name="+encodeURIComponent(name)
 75 | });
 76 | </pre>
 77 | 
 78 | <h4><strong>Step 3. send message to CppComet from php</strong></h4>
 79 | 
 80 | Code in <a href="https://github.com/CppComet/php-chat-example/blob/master/chat.php">file chat.php</a>
 81 | The code for sending a message to the pipe "simplechat" and event 'newMessage':
 82 | 
 83 | <pre>
 84 | 
 85 | // Demo access credentials
 86 | $host = "app.comet-server.ru";
 87 | $user = "15";
 88 | $password = "lPXBFPqNg3f661JcegBY0N0dPXqUBdHXqj2cHf04PZgLHxT6z55e20ozojvMRvB8";
 89 | 
 90 | // Connecting to CppComet (this is not MySQL database)
 91 | $comet = mysqli_connect($host, $user, $password, "CometQL_v1");
 92 | if(mysqli_errno($comet))
 93 | {
 94 |     echo "Error:".mysqli_error($link);
 95 | }
 96 | $msg = Array( "name" => $_POST["name"], "text"  => $_POST["text"] );
 97 | $msg = json_encode($msg);
 98 | $msg = mysqli_real_escape_string($comet, $msg);
 99 | $query = "INSERT INTO pipes_messages (name, event, message)" .
100 |   "VALUES('simplechat', 'newMessage', '".$msg."')";
101 |  
102 | // Sending message to CppComet (this is not MySQL database)
103 | mysqli_query($comet, $query); 
104 | if(mysqli_errno($comet))
105 | {
106 |     echo "Error:".mysqli_error($comet);
107 | } 
108 | else
109 | {
110 |     echo "ok";
111 | }
112 | </pre>
113 | 
114 | <h4><strong>Step 4. Receive message from CppComet in JavaScript</strong></h4>
115 | 
116 | Code in <a href="https://github.com/CppComet/php-chat-example/blob/master/index.html">file index.html</a>
117 | 
118 | Subscription Code to the pipe on comet server. This callback will be called when somebody send message into channel `simplechat`
119 | 
120 | <pre>cometApi.subscription("simplechat.newMessage", function(event){
121 |      alert(event.data.name+": "+event.data.text) 
122 | })
123 | </pre>
124 | 
125 | <h3>Demo</h3>
126 | <ul>
127 |   <li>https://github.com/CppComet/php-chat-example</li>
128 |   <li>https://jsfiddle.net/Levhav/o35kvmn2/21/</li>
129 |   <li>https://cppcomet.github.io/comet-server/demo/simple-chat/simple-chat.html</li>
130 |   <li>https://github.com/CppComet/auth-example</li>
131 | </ul>
132 | 
133 | <h3>Documentation</h3>
134 | <ul>
135 |   <li><a href="https://comet-server.com/wiki/doku.php/en:comet:building-from-source">Building from source and launch</a></li>
136 |   <li><a href="https://comet-server.com/wiki/doku.php/en:comet:cometql">CometQL API</a> documentation (To connect to the comet server api from any server-side language is used CometQL)</li>
137 |   <li><a href="https://comet-server.com/wiki/doku.php/en:comet:javascript_api#javascript_api">JavaScript API</a> documentation (To connect to the server from JavaScript)</li>
138 | </ul>
139 | 
140 | <h3>Summary</h3>
141 | I plan to write a series of articles starting with the introduction and a simple example of using CppComet from and develop an example from this article to a high-performance cluster.
142 | 
143 | With pleasure I will answer questions about the project.
144 | </div>
145 | 


--------------------------------------------------------------------------------
/index.html:
--------------------------------------------------------------------------------
 1 | <!DOCTYPE HTML>
 2 | <html>
 3 | <head> 
 4 |     <meta charset=utf-8>
 5 |     <script language="JavaScript" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.2.1/jquery.min.js" ></script>
 6 |     <script src="https://comet-server.com/CometServerApi.js" type="text/javascript"></script>
 7 |     
 8 |     <style>
 9 |     pre{
10 |         border: 1px solid #ccc;
11 |         padding: 5px;
12 |         background-color: #EEE;
13 |     }
14 |     </style>
15 | </head>
16 | <body>
17 | 
18 | <div id="web_chat"></div>
19 | 
20 | <div>
21 |  Name :<input type="text" id="name"><br><br>
22 |  Text: <textarea id="text"></textarea><br>
23 |  <input type="button" onclick="send();" value="send" ><br>
24 | </div>
25 | 
26 | <script type="text/javascript">
27 | 
28 | $(document).ready(function()
29 | { 
30 |     cometApi.start({node:"app.comet-server.ru", dev_id:15 })
31 |     
32 |     cometApi.subscription("simplechat.newMessage", function(event){
33 |         $("#web_chat").append('<b>'+HtmlEncode(event.data.name)+'</b>')
34 |         $("#web_chat").append('<pre>'+HtmlEncode(event.data.text)+'</pre>')
35 |         $("#web_chat").append('<br>')
36 |     })
37 | })
38 | 
39 | function HtmlEncode(s)
40 | {
41 |   var el = document.createElement("div");
42 |   el.innerText = el.textContent = s;
43 |   s = el.innerHTML;
44 |   return s;
45 | }
46 | 
47 |     
48 | function send()
49 | {
50 |    var name = $('#name').val();
51 |    var text = $('#text').val();
52 |    
53 |    $.ajax({
54 |         url: "https://comet-server.com/doc/CppComet/chat-example/chat.php",
55 |         type: "POST", 
56 |         data:"text="+encodeURIComponent(text)+"&name="+encodeURIComponent(name)
57 |    });
58 | }
59 | 
60 | 
61 | 
62 | 
63 | 
64 | 
65 | </script>
66 | </body>
67 | </html>
68 | 


--------------------------------------------------------------------------------
/readme.MD:
--------------------------------------------------------------------------------
 1 | 
 2 | :comet: An example of using the [CppComet](https://github.com/CppComet/comet-server) server to create a chat. For more information about CppComet, see [documentation](http://comet-server.org)
 3 | 
 4 | 
 5 | # PHP chat example
 6 | 
 7 | [codepen.io online demo](https://codepen.io/Levhav/pen/vJWWqW)
 8 | 
 9 | ![php chat demo](https://github.com/CppComet/php-chat-example/blob/master/chat.gif)
10 | 
11 | # Scheme of chat
12 | 
13 | Typical scheme of chat:
14 | 
15 | ![scheme-of-chat](https://github.com/CppComet/php-chat-example/blob/master/scheme-of-chat.jpg)
16 | 
17 | * Connecting to the comet server by websockets
18 | * Send ajax message for add new massage to chat
19 | * Send message to CppComet
20 | * CppComet send messages for all subscribers in pipe
21 | * Add message to database (optional)
22 |  
23 | # Step 1. Connecting to the comet server
24 | 
25 | [CppComet](https://github.com/CppComet/comet-server) has cloud saas alternative that can be used for testing and demo access. In the following examples I will use demonstration access from https://comet-server.com for those who could not or were too lazy to [deploy the server on their VPS](https://github.com/CppComet/comet-server#building-from-source)
26 | 
27 | ```Login: 15
28 | Password:lPXBFPqNg3f661JcegBY0N0dPXqUBdHXqj2cHf04PZgLHxT6z55e20ozojvMRvB8
29 | Host: app.comet-server.ru
30 | ```
31 | 
32 | To connect to the comet server from the JavaScript API, use the following command:
33 | 
34 | ```
35 | cometApi.start({node:"app.comet-server.ru", dev_id:15})
36 | ```
37 | 
38 | * in parameter node - set hostname of your own server
39 | * parameter dev_id - use only if you use saas service comet-server.com
40 | 
41 | 
42 | # Step 2. send message to server
43 | 
44 | * Send ajax query to php back-end
45 | * Send CometQL query for comet server
46 | 
47 | [code of php back-end](https://github.com/CppComet/php-chat-example/blob/master/chat.php)
48 | 
49 | Connection code to CppComet using MySQL protocol:
50 | ```
51 | $host = "app.comet-server.ru";
52 | $user = "15";
53 | $password = "lPXBFPqNg3f661JcegBY0N0dPXqUBdHXqj2cHf04PZgLHxT6z55e20ozojvMRvB8";
54 | $comet = mysqli_connect($host, $user, $password, "CometQL_v1");
55 | ```
56 | 
57 | 
58 | The code for sending a message to the pipe "simplechat" and event 'newMessage':
59 | ```
60 | $query = "INSERT INTO pipes_messages (name, event, message)VALUES('simplechat', 'newMessage', '".$msg."')"; 
61 | mysqli_query($comet, $query);
62 | ```
63 | 
64 | 
65 | # Step 3. receive message from comet server
66 | 
67 | subscription Code to the pipe on comet server. This callback will be called when somebody send message into channel `simplechat`
68 | 
69 | ```
70 |     cometApi.subscription("simplechat.newMessage", function(event){
71 |         $("#web_chat").append('<b>'+HtmlEncode(event.data.name)+'</b>')
72 |         $("#web_chat").append('<pre>'+HtmlEncode(event.data.text)+'</pre>')
73 |         $("#web_chat").append('<br>')
74 |     })
75 | ```
76 | 
77 | # Links
78 | 
79 | * [JavaScript API](http://comet-server.org/doku.php/en:comet:javascript_api)
80 | * [CometQL API](http://comet-server.org/doku.php/en:comet:cometql)
81 | * [Online demo](https://jsfiddle.net/o35kvmn2/5/)
82 | * [CppComet](https://github.com/CppComet/comet-server) 
83 | 


--------------------------------------------------------------------------------
/scheme of chat.odg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/CppComet/php-chat-example/7e3fa283863c3ff73e1560caf99c7da876038b1a/scheme of chat.odg


--------------------------------------------------------------------------------
/scheme-of-chat.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/CppComet/php-chat-example/7e3fa283863c3ff73e1560caf99c7da876038b1a/scheme-of-chat.jpg


--------------------------------------------------------------------------------