Compare commits

..

No commits in common. "master" and "v0.1.4" have entirely different histories.

7 changed files with 198 additions and 534 deletions

View File

@ -36,8 +36,6 @@
With this program, it's possible to use a MuC `XMPP` room to talk to a group on `Telegram` and vice versa. The aim of this program is to be just a simple gateway, just pass text from one way to the other. Once it's stable, it probably won't have more improvements, since I don't need them. With this program, it's possible to use a MuC `XMPP` room to talk to a group on `Telegram` and vice versa. The aim of this program is to be just a simple gateway, just pass text from one way to the other. Once it's stable, it probably won't have more improvements, since I don't need them.
Since version 0.1.6, Jabbergram has HTTP Upload support. If the server supports it, it will automatically upload all the files sent to the Telegram group.
### Installation<a id="orgheadline2"></a> ### Installation<a id="orgheadline2"></a>
As with any program that uses python, it should be used a virtual environment (virtualenv), but that is user selectable. It's possible to use one of the next installation methods: As with any program that uses python, it should be used a virtual environment (virtualenv), but that is user selectable. It's possible to use one of the next installation methods:
@ -48,7 +46,7 @@ Install via pip:
Clone the repository: Clone the repository:
$ git clone https://git.daemons.it/drymer/jabbergram $ git clone git://daemons.cf/jabbergram
$ cd jabbergram $ cd jabbergram
$ su -c "pip3 install -r requirements.txt" $ su -c "pip3 install -r requirements.txt"
$ su -c "python3 setup.py install" $ su -c "python3 setup.py install"
@ -83,17 +81,10 @@ There's no easy way to see this from telegram, so you can use the separate utili
### Usage<a id="orgheadline4"></a> ### Usage<a id="orgheadline4"></a>
There only can be one configuration file. This is because it can only be one bot connection, when there's more than one, message are lost. Therefore, for linking more rooms you must "link" them in the configuration. This is done simply by hooking jabber rooms with Telegram: You can create all config files you want. You will only need to pass it as parameter, but if you don't it will try to grab `config.ini` by default, and it will fail if it doesn't exist:
[Config] # it's advisable to use tmux or screen to execute the next order
JID = exampleJid@nope.org $ jabbergram.py example.ini
password = difficultPassword
muc_room = exampleMuc@muc.nope.org segunda@muc.sip.org
nick = jabbergram
token = jabbergramBotTokken
group = -10293943920 120301203
Thus, the example's muc "exampleMuc@muc.nope.org" syncs with the group "-10293943920" and "segunda@muc.sip.org" with "120 301203".
### License<a id="orgheadline5"></a> ### License<a id="orgheadline5"></a>
@ -116,8 +107,6 @@ Thus, the example's muc "exampleMuc@muc.nope.org" syncs with the group "-1029394
Con este programa es posible utilizar una sala `XMPP` para hablar con un grupo de `Telegram` y viceversa. El objetivo de este programa es el de ser sólo una pasarela sencilla, sólo tiene que pasar el texto de un lado al otro. Una vez que sea estable, probablemente no tendrá más mejoras, ya que yo no las necesito. Con este programa es posible utilizar una sala `XMPP` para hablar con un grupo de `Telegram` y viceversa. El objetivo de este programa es el de ser sólo una pasarela sencilla, sólo tiene que pasar el texto de un lado al otro. Una vez que sea estable, probablemente no tendrá más mejoras, ya que yo no las necesito.
Desde la versión 0.1.6, Jabbergram tiene soporte HTTP Upload. Si el servidor lo soporta, subirá automáticamente todos los archivos enviados desde el grupo de Telegram.
### Instalación<a id="orgheadline8"></a> ### Instalación<a id="orgheadline8"></a>
Como con cualquier programa escrito en `Python`, deberia ser usado en un entorno virtual (virtualenv), pero eso queda a la elección del usuario. Es posible utilizar uno de los siguientes métodos de instalación: Como con cualquier programa escrito en `Python`, deberia ser usado en un entorno virtual (virtualenv), pero eso queda a la elección del usuario. Es posible utilizar uno de los siguientes métodos de instalación:
@ -128,14 +117,14 @@ Instalar a través de `pip`:
Clonar el repositorio: Clonar el repositorio:
$ git clone https://git.daemons.it/drymer/jabbergram $ git clone git://daemons.cf/jabbergram
$ cd jabbergram $ cd jabbergram
$ su -c "pip3 install -r requirements.txt" $ su -c "pip3 instalar requirements.txt -r"
$ su -c "python3 setup.py install" $ su -c "python3 setup.py instalar"
### Configuración<a id="orgheadline9"></a> ### Configuración<a id="orgheadline9"></a>
Este programa es simple, no tiene ni un menú de `ayuda`. Lo primero que hay que hacer es crear el bot de `Telegram`. Para ello, hay que tener una cuenta de `Telegram` y hablar con [BotFather](https://telegram.me/botfather). A continuación, ejecuta: Este programa es simple, no tiene ni un menú de `ayuda`. Lo primero que hay que hacer es crear el bot de `Telegrama`. Para ello, hay que tener una cuenta de `Telegram` y hablar con [BotFather](https://telegram.me/botfather). A continuación, ejecuta:
/start /start
/newbot /newbot
@ -145,7 +134,7 @@ Este programa es simple, no tiene ni un menú de `ayuda`. Lo primero que hay que
NombreDelBot NombreDelBot
# Ahora hay que pulsar desactivar # Ahora hay que pulsar desactivar
La opción `/setprivacy` es para hacer que el robot pueda leer todo lo que se dice en el grupo, no sólo cuando se utilizan los comandos. Es necesario para hacer que `jabbergram` funcione. Más información sobre la creación los bots de `Telegram` en su [página web](https://core.telegram.org/bots). La opción `/setprivacy` es para hacer que el robot pueda leer todo lo que se dice en el grupo, no sólo cuando se utilizan los comandos. Es necesario para hacer que `jabbergram` funcione. Más información sobre la creación los bots de `Telegrama` en su [página web](https://core.telegram.org/bots).
A continuación, hay que crear un archivo de configuración, que llamaremos `config.ini`. En ese archivo, introduce los siguientes parámetros: A continuación, hay que crear un archivo de configuración, que llamaremos `config.ini`. En ese archivo, introduce los siguientes parámetros:
@ -163,17 +152,10 @@ No hay manera fácil de ver el ID desde `Telegram`, por lo que se puede utilizar
### Uso<a id="orgheadline10"></a> ### Uso<a id="orgheadline10"></a>
Sólo puede haber un archivo de configuración. Esto es debido a que sólo puede haber una conexión del bot, cuando hay más de una se pierden mensajes. Por lo tanto, para linkear más salas hay que "linkearlas" en la configuración. Esto se hace, simplemente, enganchando las salas de jabber con las de telegram: Se pueden crear todos los archivos de configuración que se deseen. Sólo tendrás que pasarlo como parámetro al programa, si no se hace se intentará coger el archivo `config.ini` por defecto, y se producirá un error si no existe:
[Config] # Es recomendable utilizar tmux o la pantalla para ejecutar la siguiente orden
JID = exampleJid@nope.org $ jabbergram.py example.ini
password = difficultPassword
muc_room = exampleMuc@muc.nope.org segunda@muc.sip.org
nick = jabbergram
token = jabbergramBotTokken
group = -10293943920 120301203
De este modo, el muc "exampleMuc@muc.nope.org" se sincronizará con el grupo "-10293943920", y "segunda@muc.sip.org" con "120301203". Hecho esto, solo queda ejecutarlo en la terminal: `python3 jabbergram.py config.ini`. Hay que tenerla activa siempre que se quiera que funcione, obviamente.
### Licencia<a id="orgheadline11"></a> ### Licencia<a id="orgheadline11"></a>

View File

@ -2,8 +2,6 @@
** English ** English
*** About *** About
With this program, it's possible to use a MuC =XMPP= room to talk to a group on =Telegram= and vice versa. The aim of this program is to be just a simple gateway, just pass text from one way to the other. Once it's stable, it probably won't have more improvements, since I don't need them. With this program, it's possible to use a MuC =XMPP= room to talk to a group on =Telegram= and vice versa. The aim of this program is to be just a simple gateway, just pass text from one way to the other. Once it's stable, it probably won't have more improvements, since I don't need them.
Since version 0.1.6, Jabbergram has HTTP Upload support. If the server supports it, it will automatically upload all the files sent to the Telegram group.
*** Installation *** Installation
As with any program that uses python, it should be used a virtual environment (virtualenv), but that is user selectable. It's possible to use one of the next installation methods: As with any program that uses python, it should be used a virtual environment (virtualenv), but that is user selectable. It's possible to use one of the next installation methods:
@ -14,7 +12,7 @@
Clone the repository: Clone the repository:
#+BEGIN_SRC sh #+BEGIN_SRC sh
$ git clone https://git.daemons.it/drymer/jabbergram $ git clone git://daemons.cf/jabbergram
$ cd jabbergram $ cd jabbergram
$ su -c "pip3 install -r requirements.txt" $ su -c "pip3 install -r requirements.txt"
$ su -c "python3 setup.py install" $ su -c "python3 setup.py install"
@ -50,19 +48,12 @@
There's no easy way to see this from telegram, so you can use the separate utility called =seeIdGroups.py=. To execute it, you only need to set the =token= parameter in the config file. You will need that somebody invite the bot to the group. Also, people on that group must send some messages, so the utility can grab it's id. It may take a couple. When you have the group ID you want, just press Ctrl-c, copy it to the config file (even the minus symbol), and the configuration will be done. There's no easy way to see this from telegram, so you can use the separate utility called =seeIdGroups.py=. To execute it, you only need to set the =token= parameter in the config file. You will need that somebody invite the bot to the group. Also, people on that group must send some messages, so the utility can grab it's id. It may take a couple. When you have the group ID you want, just press Ctrl-c, copy it to the config file (even the minus symbol), and the configuration will be done.
*** Usage *** Usage
There only can be one configuration file. This is because it can only be one bot connection, when there's more than one, message are lost. Therefore, for linking more rooms you must "link" them in the configuration. This is done simply by hooking jabber rooms with Telegram: You can create all config files you want. You will only need to pass it as parameter, but if you don't it will try to grab =config.ini= by default, and it will fail if it doesn't exist:
#+BEGIN_SRC sh #+BEGIN_SRC sh
[Config] # it's advisable to use tmux or screen to execute the next order
JID = exampleJid@nope.org $ jabbergram.py example.ini
password = difficultPassword
muc_room = exampleMuc@muc.nope.org segunda@muc.sip.org
nick = jabbergram
token = jabbergramBotTokken
group = -10293943920 120301203
#+END_SRC #+END_SRC
Thus, the example's muc "exampleMuc@muc.nope.org" syncs with the group "-10293943920" and "segunda@muc.sip.org" with "120 301203".
*** License *** License
#+BEGIN_SRC text #+BEGIN_SRC text
This program is free software: you can redistribute it and / or modify This program is free software: you can redistribute it and / or modify
@ -81,8 +72,6 @@
** Castellano ** Castellano
*** Acerca de *** Acerca de
Con este programa es posible utilizar una sala =XMPP= para hablar con un grupo de =Telegram= y viceversa. El objetivo de este programa es el de ser sólo una pasarela sencilla, sólo tiene que pasar el texto de un lado al otro. Una vez que sea estable, probablemente no tendrá más mejoras, ya que yo no las necesito. Con este programa es posible utilizar una sala =XMPP= para hablar con un grupo de =Telegram= y viceversa. El objetivo de este programa es el de ser sólo una pasarela sencilla, sólo tiene que pasar el texto de un lado al otro. Una vez que sea estable, probablemente no tendrá más mejoras, ya que yo no las necesito.
Desde la versión 0.1.6, Jabbergram tiene soporte HTTP Upload. Si el servidor lo soporta, subirá automáticamente todos los archivos enviados desde el grupo de Telegram.
*** Instalación *** Instalación
Como con cualquier programa escrito en =Python=, deberia ser usado en un entorno virtual (virtualenv), pero eso queda a la elección del usuario. Es posible utilizar uno de los siguientes métodos de instalación: Como con cualquier programa escrito en =Python=, deberia ser usado en un entorno virtual (virtualenv), pero eso queda a la elección del usuario. Es posible utilizar uno de los siguientes métodos de instalación:
@ -93,13 +82,13 @@
Clonar el repositorio: Clonar el repositorio:
#+BEGIN_SRC sh #+BEGIN_SRC sh
$ git clone https://git.daemons.it/drymer/jabbergram $ git clone git://daemons.cf/jabbergram
$ cd jabbergram $ cd jabbergram
$ su -c "pip3 install -r requirements.txt" $ su -c "pip3 instalar requirements.txt -r"
$ su -c "python3 setup.py install" $ su -c "python3 setup.py instalar"
#+END_SRC #+END_SRC
*** Configuración *** Configuración
Este programa es simple, no tiene ni un menú de =ayuda=. Lo primero que hay que hacer es crear el bot de =Telegram=. Para ello, hay que tener una cuenta de =Telegram= y hablar con [[https://telegram.me/botfather][BotFather]]. A continuación, ejecuta: Este programa es simple, no tiene ni un menú de =ayuda=. Lo primero que hay que hacer es crear el bot de =Telegrama=. Para ello, hay que tener una cuenta de =Telegram= y hablar con [[https://telegram.me/botfather][BotFather]]. A continuación, ejecuta:
#+BEGIN_SRC sh #+BEGIN_SRC sh
/start /start
@ -111,7 +100,7 @@
# Ahora hay que pulsar desactivar # Ahora hay que pulsar desactivar
#+END_SRC #+END_SRC
La opción =/setprivacy= es para hacer que el robot pueda leer todo lo que se dice en el grupo, no sólo cuando se utilizan los comandos. Es necesario para hacer que =jabbergram= funcione. Más información sobre la creación los bots de =Telegram= en su [[https://core.telegram.org/bots][página web]]. La opción =/setprivacy= es para hacer que el robot pueda leer todo lo que se dice en el grupo, no sólo cuando se utilizan los comandos. Es necesario para hacer que =jabbergram= funcione. Más información sobre la creación los bots de =Telegrama= en su [[https://core.telegram.org/bots][página web]].
A continuación, hay que crear un archivo de configuración, que llamaremos =config.ini=. En ese archivo, introduce los siguientes parámetros: A continuación, hay que crear un archivo de configuración, que llamaremos =config.ini=. En ese archivo, introduce los siguientes parámetros:
@ -129,19 +118,12 @@
No hay manera fácil de ver el ID desde =Telegram=, por lo que se puede utilizar el programa llamado =seeIdGroups.py=. Para ejecutarlo sólo es necesario establecer el parámetro =token= del archivo de configuración. Necesitarás que alguien invite al bot al grupo. Además, las personas de ese grupo deben enviar algunos mensajes, para que el programa pueda coger su ID. Puede llevar unos segundos el que aparezcan los mensajes. Cuando se tenga el ID de grupo que se quiere, sólo hay que pulsar Ctrl-c, copiarlo en el archivo de configuración (incluido el simbolo menos), y la configuración estará terminada. No hay manera fácil de ver el ID desde =Telegram=, por lo que se puede utilizar el programa llamado =seeIdGroups.py=. Para ejecutarlo sólo es necesario establecer el parámetro =token= del archivo de configuración. Necesitarás que alguien invite al bot al grupo. Además, las personas de ese grupo deben enviar algunos mensajes, para que el programa pueda coger su ID. Puede llevar unos segundos el que aparezcan los mensajes. Cuando se tenga el ID de grupo que se quiere, sólo hay que pulsar Ctrl-c, copiarlo en el archivo de configuración (incluido el simbolo menos), y la configuración estará terminada.
*** Uso *** Uso
Sólo puede haber un archivo de configuración. Esto es debido a que sólo puede haber una conexión del bot, cuando hay más de una se pierden mensajes. Por lo tanto, para linkear más salas hay que "linkearlas" en la configuración. Esto se hace, simplemente, enganchando las salas de jabber con las de telegram: Se pueden crear todos los archivos de configuración que se deseen. Sólo tendrás que pasarlo como parámetro al programa, si no se hace se intentará coger el archivo =config.ini= por defecto, y se producirá un error si no existe:
#+BEGIN_SRC text #+BEGIN_SRC sh
[Config] # Es recomendable utilizar tmux o la pantalla para ejecutar la siguiente orden
JID = exampleJid@nope.org $ jabbergram.py example.ini
password = difficultPassword #+END_SRC
muc_room = exampleMuc@muc.nope.org segunda@muc.sip.org
nick = jabbergram
token = jabbergramBotTokken
group = -10293943920 120301203
#+END_SRC
De este modo, el muc "exampleMuc@muc.nope.org" se sincronizará con el grupo "-10293943920", y "segunda@muc.sip.org" con "120301203". Hecho esto, solo queda ejecutarlo en la terminal: =python3 jabbergram.py config.ini=. Hay que tenerla activa siempre que se quiera que funcione, obviamente.
*** Licencia *** Licencia
#+BEGIN_SRC text #+BEGIN_SRC text
This program is free software: you can redistribute it and / or modify This program is free software: you can redistribute it and / or modify

View File

@ -1,48 +1,66 @@
- `jabbergram <#jabbergram>`__
- `English <#english>`__
.. contents:: - `About <#about>`__
- `Installation <#installation>`__
- `Configuration <#configuration>`__
- `Usage <#usage>`__
- `License <#license>`__
1 jabbergram - `Castellano <#castellano>`__
------------
1.1 English - `Acerca de <#acerca-de>`__
~~~~~~~~~~~ - `Instalación <#instalación>`__
- `Configuración <#configuración>`__
- `Uso <#uso>`__
- `Licencia <#licencia>`__
1.1.1 About jabbergram
^^^^^^^^^^^ ==========
With this program, it's possible to use a MuC ``XMPP`` room to talk to a group on ``Telegram`` and vice versa. The aim of this program is to be just a simple gateway, just pass text from one way to the other. Once it's stable, it probably won't have more improvements, since I don't need them. English
-------
Since version 0.1.6, Jabbergram has HTTP Upload support. If the server supports it, it will automatically upload all the files sent to the Telegram group. About
~~~~~
1.1.2 Installation With this program, it's possible to use a MuC ``XMPP`` room to talk to a
^^^^^^^^^^^^^^^^^^ group on ``Telegram`` and vice versa. The aim of this program is to be
just a simple gateway, just pass text from one way to the other. Once
it's stable, it probably won't have more improvements, since I don't
need them.
As with any program that uses python, it should be used a virtual environment (virtualenv), but that is user selectable. It's possible to use one of the next installation methods: Installation
~~~~~~~~~~~~
As with any program that uses python, it should be used a virtual
environment (virtualenv), but that is user selectable. It's possible to
use one of the next installation methods:
Install via pip: Install via pip:
.. code-block:: sh ::
:number-lines: 0
$ su -c "pip3 install jabbergram" $ su -c "pip3 install jabbergram"
Clone the repository: Clone the repository:
.. code-block:: sh ::
:number-lines: 0
$ git clone https://git.daemons.it/drymer/jabbergram $ git clone git://daemons.cf/jabbergram
$ cd jabbergram $ cd jabbergram
$ su -c "pip3 install -r requirements.txt" $ su -c "pip3 install -r requirements.txt"
$ su -c "python3 setup.py install" $ su -c "python3 setup.py install"
1.1.3 Configuration Configuration
^^^^^^^^^^^^^^^^^^^ ~~~~~~~~~~~~~
This program is simple, it even doesn't have a ``help`` menu. First thing you need to do is to create ``Telegram`` Bot. To do so, you must have a telegram account and talk to `BotFather <https://telegram.me/botfather>`_. Then, execute: This program is simple, it even doesn't have a ``help`` menu. First
thing you need to do is to create ``Telegram`` Bot. To do so, you must
have a telegram account and talk to
`BotFather <https://telegram.me/botfather>`__. Then, execute:
.. code-block:: sh ::
:number-lines: 0
/start /start
/newbot /newbot
@ -52,12 +70,15 @@ This program is simple, it even doesn't have a ``help`` menu. First thing you ne
YourNameBot YourNameBot
# now press Disable # now press Disable
The ``/setprivacy`` option is to make the bot read all what it's said to him, not only when using commands. It's necessary to make ``jabbergram`` work. More info on creating ``Telegram`` bots at their `webpage <https://core.telegram.org/bots>`_. The ``/setprivacy`` option is to make the bot read all what it's said to
him, not only when using commands. It's necessary to make ``jabbergram``
work. More info on creating ``Telegram`` bots at their
`webpage <https://core.telegram.org/bots>`__.
Then, you will have to create a config file. We'll call it ``config.ini``. In that file, enter the next parameters: Then, you will have to create a config file. We'll call it
``config.ini``. In that file, enter the next parameters:
.. code-block:: text ::
:number-lines: 0
[config] [config]
jid = exampleJid@nope.org jid = exampleJid@nope.org
@ -67,33 +88,35 @@ Then, you will have to create a config file. We'll call it ``config.ini``. In th
token = jabbergramBotTokken token = jabbergramBotTokken
group = -10293943920 group = -10293943920
The only thing worth mentioning is the ``token`` section, which is said to you when creating the bot, and the ``group``, that is the ``Telegram`` group ID. The only thing worth mentioning is the ``token`` section, which is said
to you when creating the bot, and the ``group``, that is the
``Telegram`` group ID.
There's no easy way to see this from telegram, so you can use the separate utility called ``seeIdGroups.py``. To execute it, you only need to set the ``token`` parameter in the config file. You will need that somebody invite the bot to the group. Also, people on that group must send some messages, so the utility can grab it's id. It may take a couple. When you have the group ID you want, just press Ctrl-c, copy it to the config file (even the minus symbol), and the configuration will be done. There's no easy way to see this from telegram, so you can use the
separate utility called ``seeIdGroups.py``. To execute it, you only need
to set the ``token`` parameter in the config file. You will need that
somebody invite the bot to the group. Also, people on that group must
send some messages, so the utility can grab it's id. It may take a
couple. When you have the group ID you want, just press Ctrl-c, copy it
to the config file (even the minus symbol), and the configuration will
be done.
1.1.4 Usage Usage
^^^^^^^^^^^ ~~~~~
There only can be one configuration file. This is because it can only be one bot connection, when there's more than one, message are lost. Therefore, for linking more rooms you must "link" them in the configuration. This is done simply by hooking jabber rooms with Telegram: You can create all config files you want. You will only need to pass it
as parameter, but if you don't it will try to grab ``config.ini`` by
default, and it will fail if it doesn't exist:
.. code-block:: sh ::
:number-lines: 0
[Config] # it's advisable to use tmux or screen to execute the next order
JID = exampleJid@nope.org $ jabbergram.py example.ini
password = difficultPassword
muc_room = exampleMuc@muc.nope.org segunda@muc.sip.org
nick = jabbergram
token = jabbergramBotTokken
group = -10293943920 120301203
Thus, the example's muc "exampleMuc@muc.nope.org" syncs with the group "-10293943920" and "segunda@muc.sip.org" with "120 301203". License
~~~~~~~
1.1.5 License ::
^^^^^^^^^^^^^
.. code-block:: text
:number-lines: 0
This program is free software: you can redistribute it and / or modify This program is free software: you can redistribute it and / or modify
it under the terms of the GNU General Public License as published by it under the terms of the GNU General Public License as published by
@ -108,45 +131,50 @@ Thus, the example's muc "exampleMuc@muc.nope.org" syncs with the group "-1029394
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
Along With This Program. If not, see <http://www.gnu.org/licenses/>. Along With This Program. If not, see <http://www.gnu.org/licenses/>.
1.2 Castellano Castellano
~~~~~~~~~~~~~~ ----------
1.2.1 Acerca de Acerca de
^^^^^^^^^^^^^^^ ~~~~~~~~~
Con este programa es posible utilizar una sala ``XMPP`` para hablar con un grupo de ``Telegram`` y viceversa. El objetivo de este programa es el de ser sólo una pasarela sencilla, sólo tiene que pasar el texto de un lado al otro. Una vez que sea estable, probablemente no tendrá más mejoras, ya que yo no las necesito. Con este programa es posible utilizar una sala ``XMPP`` para hablar con
un grupo de ``Telegram`` y viceversa. El objetivo de este programa es el
de ser sólo una pasarela sencilla, sólo tiene que pasar el texto de un
lado al otro. Una vez que sea estable, probablemente no tendrá más
mejoras, ya que yo no las necesito.
Desde la versión 0.1.6, Jabbergram tiene soporte HTTP Upload. Si el servidor lo soporta, subirá automáticamente todos los archivos enviados desde el grupo de Telegram. Instalación
~~~~~~~~~~~
1.2.2 Instalación Como con cualquier programa escrito en ``Python``, deberia ser usado en
^^^^^^^^^^^^^^^^^ un entorno virtual (virtualenv), pero eso queda a la elección del
usuario. Es posible utilizar uno de los siguientes métodos de
Como con cualquier programa escrito en ``Python``, deberia ser usado en un entorno virtual (virtualenv), pero eso queda a la elección del usuario. Es posible utilizar uno de los siguientes métodos de instalación: instalación:
Instalar a través de ``pip``: Instalar a través de ``pip``:
.. code-block:: sh ::
:number-lines: 0
$ su -c "pip3 instalar jabbergram" $ su -c "pip3 instalar jabbergram"
Clonar el repositorio: Clonar el repositorio:
.. code-block:: sh ::
:number-lines: 0
$ git clone https://git.daemons.it/drymer/jabbergram $ git clone git://daemons.cf/jabbergram
$ cd jabbergram $ cd jabbergram
$ su -c "pip3 instalar -r requirements.txt" $ su -c "pip3 instalar requirements.txt -r"
$ su -c "python3 setup.py install" $ su -c "python3 setup.py instalar"
1.2.3 Configuración Configuración
^^^^^^^^^^^^^^^^^^^ ~~~~~~~~~~~~~
Este programa es simple, no tiene ni un menú de ``ayuda``. Lo primero que hay que hacer es crear el bot de ``Telegram``. Para ello, hay que tener una cuenta de ``Telegram`` y hablar con `BotFather <https://telegram.me/botfather>`_. A continuación, ejecuta: Este programa es simple, no tiene ni un menú de ``ayuda``. Lo primero
que hay que hacer es crear el bot de ``Telegrama``. Para ello, hay que
tener una cuenta de ``Telegram`` y hablar con
`BotFather <https://telegram.me/botfather>`__. A continuación, ejecuta:
.. code-block:: sh ::
:number-lines: 0
/start /start
/newbot /newbot
@ -156,12 +184,17 @@ Este programa es simple, no tiene ni un menú de ``ayuda``. Lo primero que hay q
NombreDelBot NombreDelBot
# Ahora hay que pulsar desactivar # Ahora hay que pulsar desactivar
La opción ``/setprivacy`` es para hacer que el robot pueda leer todo lo que se dice en el grupo, no sólo cuando se utilizan los comandos. Es necesario para hacer que ``jabbergram`` funcione. Más información sobre la creación los bots de ``Telegrama`` en su `página web <https://core.telegram.org/bots>`_. La opción ``/setprivacy`` es para hacer que el robot pueda leer todo lo
que se dice en el grupo, no sólo cuando se utilizan los comandos. Es
necesario para hacer que ``jabbergram`` funcione. Más información sobre
la creación los bots de ``Telegrama`` en su `página
web <https://core.telegram.org/bots>`__.
A continuación, hay que crear un archivo de configuración, que llamaremos ``config.ini``. En ese archivo, introduce los siguientes parámetros: A continuación, hay que crear un archivo de configuración, que
llamaremos ``config.ini``. En ese archivo, introduce los siguientes
parámetros:
.. code-block:: text ::
:number-lines: 0
[Config] [Config]
JID = exampleJid@nope.org JID = exampleJid@nope.org
@ -171,33 +204,37 @@ A continuación, hay que crear un archivo de configuración, que llamaremos ``co
token = jabbergramBotTokken token = jabbergramBotTokken
group = -10,293,943,920 group = -10,293,943,920
La única cosa que vale la pena mencionar es la sección del ``token`` (que es la que nos da cuando se crea el robot) y el ``group``, que es ID del grupo de ``Telegram``. La única cosa que vale la pena mencionar es la sección del ``token``
(que es la que nos da cuando se crea el robot) y el ``group``, que es ID
del grupo de ``Telegram``.
No hay manera fácil de ver el ID desde ``Telegram``, por lo que se puede utilizar el programa llamado ``seeIdGroups.py``. Para ejecutarlo sólo es necesario establecer el parámetro ``token`` del archivo de configuración. Necesitarás que alguien invite al bot al grupo. Además, las personas de ese grupo deben enviar algunos mensajes, para que el programa pueda coger su ID. Puede llevar unos segundos el que aparezcan los mensajes. Cuando se tenga el ID de grupo que se quiere, sólo hay que pulsar Ctrl-c, copiarlo en el archivo de configuración (incluido el simbolo menos), y la configuración estará terminada. No hay manera fácil de ver el ID desde ``Telegram``, por lo que se puede
utilizar el programa llamado ``seeIdGroups.py``. Para ejecutarlo sólo es
necesario establecer el parámetro ``token`` del archivo de
configuración. Necesitarás que alguien invite al bot al grupo. Además,
las personas de ese grupo deben enviar algunos mensajes, para que el
programa pueda coger su ID. Puede llevar unos segundos el que aparezcan
los mensajes. Cuando se tenga el ID de grupo que se quiere, sólo hay que
pulsar Ctrl-c, copiarlo en el archivo de configuración (incluido el
simbolo menos), y la configuración estará terminada.
1.2.4 Uso Uso
^^^^^^^^^ ~~~
Sólo puede haber un archivo de configuración. Esto es debido a que sólo puede haber una conexión del bot, cuando hay más de una se pierden mensajes. Por lo tanto, para linkear más salas hay que "linkearlas" en la configuración. Esto se hace, simplemente, enganchando las salas de jabber con las de telegram: Se pueden crear todos los archivos de configuración que se deseen. Sólo
tendrás que pasarlo como parámetro al programa, si no se hace se
intentará coger el archivo ``config.ini`` por defecto, y se producirá un
error si no existe:
.. code-block:: text ::
:number-lines: 0
[Config] # Es recomendable utilizar tmux o la pantalla para ejecutar la siguiente orden
JID = exampleJid@nope.org $ jabbergram.py example.ini
password = difficultPassword
muc_room = exampleMuc@muc.nope.org segunda@muc.sip.org
nick = jabbergram
token = jabbergramBotTokken
group = -10293943920 120301203
De este modo, el muc "exampleMuc@muc.nope.org" se sincronizará con el grupo "-10293943920", y "segunda@muc.sip.org" con "120301203". Licencia
~~~~~~~~
1.2.5 Licencia ::
^^^^^^^^^^^^^^
.. code-block:: text
:number-lines: 0
This program is free software: you can redistribute it and / or modify This program is free software: you can redistribute it and / or modify
it under the terms of the GNU General Public License as published by it under the terms of the GNU General Public License as published by

View File

@ -1,411 +1,79 @@
#!/usr/bin/env python3 #!/usr/bin/env python3
# -*- coding: utf-8 -*- # -*- coding: utf-8 -*-
import configparser
import logging
from sys import argv
from threading import Thread
from time import sleep
from xml.dom import minidom
import sleekxmpp import sleekxmpp
import telegram import telegram
from sleekxmpp.xmlstream.stanzabase import ElementBase import configparser
from threading import Thread
from queue import Queue
from telegram.error import NetworkError, Unauthorized from telegram.error import NetworkError, Unauthorized
from time import sleep
from sys import argv
from sys import exit
try: class EchoBot(sleekxmpp.ClientXMPP):
import requests def __init__(self, jid, password, room, nick, token, group):
except:
logging.error("HTTP Upload support disabled.")
class Request(ElementBase):
"""Special class to create http_upload requests."""
namespace = 'urn:xmpp:http:upload'
name = 'request'
plugin_attrib = 'request'
interfaces = set(('filename', 'size'))
sub_interfaces = interfaces
class Jabbergram(sleekxmpp.ClientXMPP):
"""Main object."""
def __init__(self, jid, password, rooms, nick, token, groups, verify_ssl):
"""
Executed when the class is initialized. It adds session handlers, muc
handlers and send the telegram reading function and the HTTP upload
initializing functions to their respective threads.
"""
# XMPP # XMPP
super(Jabbergram, self).__init__(jid, password) super(EchoBot, self).__init__(jid, password)
self.add_event_handler('session_start', self.start) self.add_event_handler('session_start', self.start)
self.add_event_handler('groupchat_message', self.muc_message) self.add_event_handler('groupchat_message', self.muc_message)
self.muc_room = room
self.muc_rooms = rooms.split()
self.nick = nick self.nick = nick
self.token = token self.token = token
self.xmpp_users = {}
self.jid = jid
self.verify_ssl = verify_ssl
for muc in self.muc_rooms:
self.add_event_handler("muc::%s::got_online" % muc,
self.muc_online)
self.add_event_handler("muc::%s::got_offline" % muc,
self.muc_offline)
# Telegram # Telegram
self.groups = groups.split() self.group = group
self.bot = telegram.Bot(self.token) self.bot = telegram.Bot(self.token)
self.telegram_users = {}
# initialize http upload on a thread since its needed to be connected # meter el conecto del tg en un hilo
# to xmpp
t = Thread(target=self.init_http)
t.daemon = True
t.start()
# put tg connector in a thread
t = Thread(target=self.read_tg) t = Thread(target=self.read_tg)
t.daemon = True t.daemon = True
t.start() t.start()
print('Please wait a couple of minutes until it\'s correctly ' print('Please wait a couple of minutes until it\'s correctly '
'connected') 'connected')
def init_http(self):
"""
Initializes HTTP upload support. Sends a discovery stanza to the server
to find the HTTP upload component and asks for the max size a file can
be.
"""
self.http_upload = self.HttpUpload(self)
self.component = self.http_upload.discovery()
if self.component:
xml = self.http_upload.disco_info(self.component)
xml = minidom.parseString(str(xml))
self.max_size = int(xml.getElementsByTagName('value')
[1].firstChild.data)
else:
try:
self.component = self.jid.split('@')[1]
xml = self.http_upload.disco_info(self.component)
xml = minidom.parseString(str(xml))
self.max_size = int(xml.getElementsByTagName('value')
[1].firstChild.data)
except:
self.max_size = None
def read_tg(self): def read_tg(self):
"""Main telegram function."""
update_id = 0 update_id = 0
# wait until http_upload has been tested
sleep(5)
while True: while True:
try: try:
for update in self.bot.getUpdates(offset=update_id, for update in self.bot.getUpdates(offset=update_id,
timeout=10): timeout=10):
name = '' message = update.message.text
size = 0 user = str(update.message.from_user.username)
if update.edited_message: if not user:
update_id = update.update_id + 1 user = str(update.message.from_user.first_name)
continue
if update.message.from_user: mensaje = user + ": " + message
user = update.message.from_user.username chat_id = update.message.chat_id
# sometimes there's no user. weird, but it happens if message and chat_id == self.group:
if not user: self.send_message(mto=self.muc_room,
user = update.message.from_user.first_name mbody=mensaje,
# sometimes there's no user. weird, but it happens
elif update.message['from']:
user = str(update.message['from'].first_name)
if update.message.audio or update.message.document or \
update.message.photo or update.message.video \
or update.message.voice or update.message.sticker:
# proceed only if http upload is available
if self.max_size is not None:
if update.message.audio:
d_file = update.message.audio
ext = '.ogg'
size = d_file.file_size
elif update.message.document:
d_file = update.message.document
ext = ''
size = d_file.file_size
elif update.message.photo:
d_file = update.message.photo[-1]
ext = '.jpg'
size = d_file.file_size
elif update.message.video:
d_file = update.message.video[-1]
ext = '.mp4'
size = d_file.file_size
elif update.message.voice:
d_file = update.message.voice
ext = '.ogg'
size = d_file.file_size
elif update.message.sticker:
d_file = update.message.sticker
ext = '.png'
size = d_file.file_size
if self.max_size >= int(size):
t_file = self.bot.getFile(d_file.file_id)
f_name = '/tmp/' + d_file.file_id + ext
t_file.download(f_name)
url = self.http_upload.upload(
self.component,
self.verify_ssl,
f_name, size)
if update.message.caption:
message = update.message.caption + ' '
else:
message = 'File uploaded: '
message += url
else:
message = 'A file has been uploaded to Telegr'\
'am, but is too big.'
else:
message = 'A file has been uploaded to Telegram,'\
'but the XMPP server doesn\'t support H'\
'TTP Upload.'
elif update.message.new_chat_members:
message = 'This user has joined the group.'
elif update.message.left_chat_member:
message = 'This user has left the group.'
elif update.message.new_chat_title:
message = 'The group\'s title has changed: ' + \
update.message.new_chat_title
elif update.message.new_chat_photo:
message = 'The group\'s photo has changed.'
else:
if update.message.reply_to_message:
name = update.message.reply_to_message.from_user\
.username
if name != self.bot.username:
message = name + ': ' + \
update.message.reply_to_message.text
else:
message = update.message.reply_to_message.text
else:
message = update.message.text
if name:
msg = message + ' <- ' + user + ": " + \
update.message.text
else:
msg = user + ": " + message
if update.message.chat.type == 'supergroup' and \
update.message.chat.username:
chat = '@' + update.message.chat.username
else:
chat = str(update.message.chat.id)
if chat not in self.groups:
chat = str(update.message.chat_id)
if message and chat in self.groups:
index = self.groups.index(chat)
receiver = self.muc_rooms[index]
if chat in self.telegram_users:
if user not in self.telegram_users[chat]:
self.telegram_users[chat] += ' ' + user
else:
self.telegram_users[chat] = ' ' + user
if message == '.users':
self.say_users('telegram', receiver, chat)
elif message == '.help':
self.say_help('telegram', receiver, chat)
elif message == '.where':
self.say_where('telegram', receiver, chat)
else:
self.send_message(mto=receiver, mbody=msg,
mtype='groupchat') mtype='groupchat')
update_id = update.update_id + 1 update_id = update.update_id + 1
except NetworkError as e: except NetworkError:
print(e)
sleep(1) sleep(1)
except Unauthorized:
except Unauthorized as e:
print(e)
sleep(1) sleep(1)
except Exception as e:
update_id += 1
print(e)
def start(self, event): def start(self, event):
"""Does some initial setup for XMPP and joins all mucs."""
self.get_roster() self.get_roster()
self.send_presence() self.send_presence()
self.plugin['xep_0045'].joinMUC(self.muc_room, self.nick, wait=True)
for muc in self.muc_rooms:
self.plugin['xep_0045'].joinMUC(muc, self.nick, wait=True)
def muc_message(self, msg): def muc_message(self, msg):
"""Muc message's handler.""" if msg['mucnick'] != self.nick:
muc_room = str(msg['from']).split('/')[0] mensaje = str(msg['from']).split('/')[1] + ': ' + str(msg['body'])
index = self.muc_rooms.index(muc_room) self.bot.sendMessage(self.group, text=mensaje)
tg_group = self.groups[index]
if msg['body'] == '.users':
self.say_users('xmpp', muc_room, tg_group)
elif msg['body'] == '.help':
self.say_help('xmpp', muc_room, tg_group)
elif msg['body'] == '.where':
self.say_where('xmpp', muc_room, tg_group)
elif msg['mucnick'] != self.nick:
message = str(msg['from']).split('/')[1] + ': ' + str(msg['body'])
self.bot.sendMessage(tg_group, text=message)
def muc_online(self, presence):
"""Muc presence's handler."""
user = presence['muc']['nick']
muc = presence['from'].bare
if user != self.nick:
if muc in self.xmpp_users:
self.xmpp_users[muc].append(presence['muc']['nick'])
else:
self.xmpp_users[muc] = [presence['muc']['nick']]
def muc_offline(self, presence):
"""Muc presence's handler."""
user = presence['muc']['nick']
muc = presence['from'].bare
if user != self.nick:
self.xmpp_users[muc].remove(presence['muc']['nick'])
def say_users(self, service, muc, group):
"""It returns the users on XMPP or Telegram."""
if service == 'xmpp':
if group in self.telegram_users:
tg_users = self.telegram_users[group]
else:
tg_users = ""
msg = 'Telegram Users:' + tg_users
self.send_message(mto=muc, mbody=msg, mtype='groupchat')
elif service == 'telegram':
xmpp_users = ""
if muc in self.xmpp_users:
for i in self.xmpp_users[muc]:
xmpp_users = xmpp_users + ' ' + i
else:
xmpp_users = ""
msg = 'XMPP Users:' + xmpp_users
self.bot.sendMessage(group, text=msg)
def say_help(self, service, muc, group):
"""Help command."""
msg = 'Hi, I\'m ' + self.bot.username + '. I have two commands : ".us'\
'ers" and ".where".'
if service == 'xmpp':
self.send_message(mto=muc, mbody=msg, mtype='groupchat')
elif service == 'telegram':
self.bot.sendMessage(group, text=msg)
def say_where(self, service, muc, group):
"""Returns Telegram's group location if it's public."""
if service == 'xmpp':
if '@' in group:
msg = 'I\'m on http://telegram.me/' + group.split('@')[1] + '.'
else:
msg = 'Sorry, I\'m on a private group, you\'ll have to ask fo'\
'r an invitation.'
self.send_message(mto=muc, mbody=msg, mtype='groupchat')
elif service == 'telegram':
msg = 'I\'m on ' + muc + '.'
self.bot.sendMessage(group, text=msg)
class HttpUpload():
"""HTTP upload main class."""
def __init__(self, parent_self):
"""Init... Yep."""
self.parent_self = parent_self
def discovery(self):
"""Discovers all server's components."""
disco = sleekxmpp.basexmpp.BaseXMPP.Iq(self.parent_self)
disco['query'] = "http://jabber.org/protocol/disco#items"
disco['type'] = 'get'
disco['from'] = self.parent_self.jid
disco['to'] = self.parent_self.jid.split('@')[1]
d = disco.send(timeout=30)
xml = minidom.parseString(str(d))
item = xml.getElementsByTagName('item')
for component in item:
component = component.getAttribute('jid')
info = self.disco_info(component)
if "urn:xmpp:http:upload" in info:
http_upload_component = component
break
else:
http_upload_component = ""
return http_upload_component
def disco_info(self, component):
"""Discovers HTTP upload components attributes."""
info = sleekxmpp.basexmpp.BaseXMPP.Iq(self.parent_self)
info['query'] = "http://jabber.org/protocol/disco#info"
info['type'] = 'get'
info['from'] = self.parent_self.jid
info['to'] = component
response = str(info.send(timeout=30))
return response
def upload(self, component, verify_ssl, u_file, size):
"""Uploads to HTTP upload."""
peticion = Request()
peticion['filename'] = u_file.split('/')[-1]
peticion['size'] = str(size)
iq = sleekxmpp.basexmpp.BaseXMPP.Iq(self.parent_self)
iq.set_payload(peticion)
iq['type'] = 'get'
iq['to'] = component
iq['from'] = self.parent_self.jid
send = iq.send(timeout=30)
xml = minidom.parseString(str(send))
put_url = xml.getElementsByTagName('put')[0].firstChild.data
if verify_ssl == 'False':
req = requests.put(put_url, data=open(u_file, 'rb'),
verify=False)
else:
req = requests.put(put_url, data=open(u_file, 'rb'))
return put_url
if __name__ == '__main__': if __name__ == '__main__':
# parse config # parsear config
config = [] config = []
parser = configparser.SafeConfigParser() parser = configparser.SafeConfigParser()
@ -417,17 +85,15 @@ if __name__ == '__main__':
for name, value in parser.items('config'): for name, value in parser.items('config'):
config.append(value) config.append(value)
# assign values for the bot # asignar valores para el bot
jid = config[0] jid = config[0]
password = config[1] password = config[1]
muc_rooms = config[2] muc_room = config[2]
nick = config[3] nick = config[3]
token = config[4] token = config[4]
groups = config[5] group = int(config[5])
verify_ssl = config[6]
xmpp = Jabbergram(jid, password, muc_rooms, nick, token, groups, xmpp = EchoBot(jid, password, muc_room, nick, token, group)
verify_ssl)
xmpp.register_plugin('xep_0045') xmpp.register_plugin('xep_0045')
if xmpp.connect(): if xmpp.connect():
@ -435,3 +101,5 @@ if __name__ == '__main__':
print("Done") print("Done")
else: else:
print("Unable to connect.") print("Unable to connect.")
# Vols un gram nen?

View File

@ -1,3 +1,2 @@
sleekxmpp >= 1.3.2 sleekxmpp >= 1.3.1
python-telegram-bot >= 6.1.0 python-telegram-bot >= 4.0.3
requests >= 2.11.1

View File

@ -30,9 +30,6 @@ printed = []
while True: while True:
try: try:
for update in bot.getUpdates(offset=update_id, timeout=10): for update in bot.getUpdates(offset=update_id, timeout=10):
if update.edited_message:
update_id = update.update_id + 1
continue
chat_id = update.message.chat_id chat_id = update.message.chat_id
chat_title = update.message chat_title = update.message
if chat_id not in printed: if chat_id not in printed:

View File

@ -2,7 +2,7 @@
from setuptools import setup from setuptools import setup
VERSION = '0.1.8' VERSION = '0.1.4'
setup(name='jabbergram', setup(name='jabbergram',
version=VERSION, version=VERSION,
@ -10,14 +10,13 @@ setup(name='jabbergram',
long_description=open('README.rst', encoding='utf-8').read(), long_description=open('README.rst', encoding='utf-8').read(),
author='drymer', author='drymer',
author_email='drymer@autistici.org', author_email='drymer@autistici.org',
url='http://git.daemons.it/drymer/jabbergram/about/', url='http://daemons.cf/cgit/jabbergram/about/',
download_url='https://git.daemons.it/drymer/jabbergram/archive/' + VERSION + '.tar.gz', download_url='http://daemons.cf/cgit/jabbergram/snapshot/jabbergram-' + VERSION + '.tar.gz',
scripts=['jabbergram.py'], scripts=['jabbergram.py'],
license="GPLv3", license="GPLv3",
install_requires=[ install_requires=[
"sleekxmpp>=1.3.1", "sleekxmpp>=1.3.1",
"python-telegram-bot>=6.0.1", "python-telegram-bot>=4.0.3",
"requests>=2.11.1",
], ],
classifiers=["Development Status :: 4 - Beta", classifiers=["Development Status :: 4 - Beta",
"Programming Language :: Python", "Programming Language :: Python",