williamson/laragram

A Laravel Wrapper for telegram-cli

Laravel Wrapper for telegram-cli

This project was originally forked from: php-telegram-cli-client and credit to zyberspace for the start I needed to get this project working., _(*1)

What is new in 1.0?

• To make the laravel service provider "deferred" (performance enhancing feature), you must now manually register the TG alias in the config/app.php alias section.

What is it?

This project allows you to use the lovely Laravel syntax you are familar with to quickly and easily send messages / images / documents / audio files / location via Telegram Messenger with the aid of telegram-cli running on your server., _(*2)

It allows you do things like:, _(*3)

    TG::sendMessage('User_name', 'Hi there your account has been set up! Thanks!');

or, _(*4)

    TG::sendDocument('User_name', '/home/data/files/important.pdf');

or, _(*5)

    TG::sendImage('User_name', 'http://upload.wikimedia.org/wikipedia/commons/1/16/HDRI_Sample_Scene_Balls_(JPEG-HDR).jpg');

Of course if you don't like using Facades you can always revert to, _(*6)

    // $tg is an instantiated TgCommands Object. Laravel will create this out of the IOC container for
    // you if typehinted in constructor etc. 
    $tg->sendMessage('User_name', 'Hi there your account has been set up! Thanks!');

Requirements

• A running telegram-cli listening on a unix-socket (-S) or a port (-P). Needs to be configured already (phone-number, etc.).
• php >= 5.4.0
• curl installed
• json flag added to the telegram daemon startup command

Installing Telegram-cli

Setup telegram-cli

Telegram-cli needs to run on a unix-socket (-S) or a port (-P), so laragram can connect to it. Please read the instructions at telegram-cli on how to configure and then make, _(*7)

If your build was successful you can continue!, _(*8)

First time running telegram-cli

If you never started telegram-cli before, you need to start it first in normal mode, so you can type in your telegram-phone-number and register it., _(*9)

Assuming you installed telegram in ~/telegram your command should look like this: ~/telegram/bin/telegram-cli., _(*10)

Once registered, you can exit telegram-cli (safe_quit) and launch it as a daemon., _(*11)

Running telegram-cli as a daemon

To run telegram-cli as a daemon you need to use the -d flag and set a unix socket -S., _(*12)

~/telegram/bin/telegram-cli -k ~/telegram/tg-server.pub -dWS /tmp/tg.sck --json

Or instead you may use a TCP port, _(*13)

~/telegram/bin/telegram-cli -k ~/telegram/tg-server.pub -dWP 7777 --json

The -W switch means the contact-list gets loaded on startup - this allows you to send messages straight away. The & at the ends means that the command will load in the background allowing you to continue with the script., _(*14)

To stop the daemon use killall telegram-cli or kill -TERM [telegram-pid]., _(*15)

You now have Telegram-cli working and waiting to be told what to send!, _(*16)

To ensure your daemon does not exit unexpectantly, you can use something like supervisor to make sure the process always is running. See notes at the end of how this can be set up., _(*17)

Installing Laragram

Install Laragram with composer

In your laravel project-root:, _(*18)

composer require williamson/laragram

Service Providers and Facades

Open config/app.php file, find the providers array and add to the bottom, _(*19)

        'Williamson\Laragram\Laravel\LaragramServiceProvider'

If you're running Laravel 5.1 or greater you can use this syntax instead in the config/app.php file:, _(*20)

        Williamson\Laragram\Laravel\LaragramServiceProvider::class

Note the lack of single quotes for the laravel 5 version., _(*21)

Now you add the following line to the Alias array in config/app.php to register the shorthand TG facade, _(*22)

        'TG' => \Williamson\Laragram\Laravel\LaragramFacade::class,

Open config/services.php file, add the following array to specify what type of socket you would like to connect to the telegram daemon., _(*23)

    'telegram' => [
        'socket' =>'tcp://127.0.0.1:7778'
    ]

Other values include unix sockets. ie 'socket' => 'unix:///tmp/tg.sck', _(*24)

You're done!, _(*25)

Using Laragram

Now anywhere in your app you can send a telegram message quickly and easily like follows:, _(*26)

   // routes.php

     Route::get('/test', function (){
          TG::sendMsg('<name or telegram id number>', 'Hello there!');
     });

Remember that the name should have underscores instead of spaces eg firstname_lastname, OR you can use user#and then the persons telegram ID directly. This method is far more reliable. eg user#123456789, _(*27)

In addition to sendMessage, the following commands are available to you:, _(*28)

broadcastMsg
chatAddUser
chatCreateGroup
chatCreateSecret
chatDelUser
chatExportLink
chatInfo
chatRename
chatSetPhoto
contactAdd
contactDelete
contactList
contactRename
deleteMsg
exportCard
getContactList
getDialogList
getHistory
getUserInfo
markRead
msg
sendAudio
sendContact
sendDocument
sendLocation
sendMsg
sendPhoto
sendText
sendTypingStart
sendTypingStop
sendVideo
setProfileName
setProfilePhoto
setStatusOffline
setStatusOnline
setUsername

License

This software is licensed under the Mozilla Public License v. 2.0. For more information, read the file LICENSE., _(*29)

Using Supervisor

Assuming that you have, _(*30)

• supervisord installed on your system (if not supervisord install ) and
• telegram has been installed in /home/username/telegram

Then create a new file /etc/supervisor/conf.d/telegram.conf, _(*31)

and copy the following into it, adding/replacing any log files you wish to create, _(*32)

[program:telegram]
command=/bin/bash -c "rm -f /tmp/tg.sck && /home/username/telegram/bin/telegram-cli -k /home/username/telegram/tg-server.pub -dWS /tmp/tg.sck --json"
;For tcp socket this could be
;command=/bin/bash -c "/home/username/telegram/bin/telegram-cli -k /home/username/telegram/tg-server.pub -dWP 7777 --json"
directory=/home/username/telegram
redirect_stderr=true
stopsignal=KILL
stopasgroup=true
autostart=true
autorestart=true
startretries=3
user=<insert linux username>
stdout_logfile=<insert your own log folder and log filename. Must exist>
stderr_logfile=<insert your own log folder and log filename. Must exist>
stdout_logfile_maxbytes=10MB
stdout_logfile_backups=10
stdout_capture_maxbytes=1MB

Save the file and restart supervisor (make sure that telegram-cli is NOT running before you do this, supervisor will now take care of insuring that the process always runs even if it crashes)., _(*33)

sudo service supervisor restart

You can view how the process is doing by using the monitoring program sudo supervisorctl, _(*34)