Fernschreiber

A Telegram client for Sailfish OS

Authors

Sebastian J. Wolf sebastian@ygriega.de and several contributors

Contributions

Fernschreiber wouldn't be the same without all the people helping in making it better. Thank you very much to all contributors!

Code (Features, Bugfixes, Optimizations etc.)

• Chat list model, chat model, notifications, TDLib receiver, animated stickers, project dependencies, qml/c++ optimizations, chatPhoto, TDLibFile, code reviews, logging categories: Slava Monich
• Chat info page, performance improvements to chat page, location support, app initialization/registration with Telegram, project dependencies, emoji handling, qml/js optimizations, multi-message actions, i18n fixes, chat permission handling, code reviews, logging categories, bot support, github build: jgibbon
• Copy message to clipboard Christian Stemmle
• Hide send message button if send-by-enter is switched on, focus text input on entering a chat santhoshmanikandan

Logo/Icon

• Designed by Matteo, adjustments by Slava Monich

Translations

• Chinese: dashinfantry
• Finnish: jorm1s
• French: Patrick Hervieux, Nicolas Bourdais
• Hungarian: edp17
• Italian: Matteo
• Polish: atlochowski
• Russian: Rustem Abzalov and Slava Monich
• Slovak: okruhliak
• Spanish: carlosgonz
• Swedish: Åke Engelbrektson

License

Licensed under GNU GPLv3

Build

Local build

Simply clone this repository and ensure to have all submodules imported as well (e.g. by using git submodule update --init). Then use the project file harbour-fernschreiber.pro to import the sources in your SailfishOS IDE. To build and run Fernschreiber or an application which is based on Fernschreiber, you need to create the file harbour-fernschreiber/src/tdlibsecrets.h and enter the required constants in the following format:

#ifndef TDLIBSECRETS_H
#define TDLIBSECRETS_H
const char TDLIB_API_ID[] = "42424242";
const char TDLIB_API_HASH[] = "1234567890abcdef1234567890abcdef";
#endif // TDLIBSECRETS_H

You get the Telegram API ID and hash as soon as you've registered your own application on https://my.telegram.org.

Moreover, you need to have a compiled version of TDLib 1.7 in the sub-directory tdlib. This sub-directory must contain another sub-directory that fits to the target device architecture (e.g. armv7hl, i486). Within this directory, there needs to be a folder called lib that contains at least libtdjson.so. For armv7hl the relative path would consequently be tdlib/armv7hl/lib.

You may just want to download the tdlib.zip from our fork to just use the exact version of the latest official Fernschreiber release. To use it, you need to extract it into your local tdlib/ folder as described above. If so, you're done and can compile Fernschreiber using the Sailfish SDK. If you want to build TDLib for yourself, please keep on reading.

In case you encounter strange performance issues on startup (several seconds delay, app seems to do nothing), please be sure to follow the instructions from the respective GitHub issue, i.e. let TDLib build SQLite with -DOMIT_MEMLOCK and be sure to comment the two lines 22558 (#ifndef OMIT_MEMLOCK) and 22567 (#endif) in the file sqlite/sqlite/sqlite3.c.

Moreover, TDLib 1.7 has issues loading some pinned messages in case the message database is used (which is the case in Fernschreiber). A small patch is required to make TDLib work properly in all cases. See the respective TDLib issue for more details.

In case you want to use the same codebase which was used to compile the library that is shipped with Fernschreiber, please check out the fork, be sure to use the branch fernschreiber and compile these sources using the following commands (be sure to have the Sailfish OS build engine running):

• alias sfdk=~/SailfishOS/bin/sfdk
• sfdk config target=SailfishOS-3.3.0.16-armv7hl (this compiles the sources on SFOS 3.3 and ARM - the target needs to be adjusted according to the running SDK engine and the platform)
• mkdir build
• cd build
• sfdk build-shell cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX:PATH=../tdlib -DTD_ENABLE_LTO=ON .. (in case of compilation issues, try removing the flag -DTD_ENABLE_LTO=ON)
• sfdk build-shell cmake --build . --target install

You'll find the compiled library in the directory td/tdlib.

Github Action

Please read the "Local build" section anyway to understand what's going on before continuing. If you want to automatically build your fork on Github, you'll still need to get a Telegram API ID and hash. These are then added as project secrets named TDLIB_API_ID and TDLIB_API_HASH.

By default, only commits to the master branch will be built. You may change that for your fork, but please don't create a pull request to the official repository changing the github action without consulting the Fernschreiber contributors first.

If you push a tag containing the letter "v" (for example "v0.99.3"), a github release will be created allowing easy download of the resulting rpms. If the tag is named for example "pre-0.99.3", the resulting release is marked as a pre-release for testing purposes.

Debug

Fernschreiber does only output a few TDLib messages by default. To get its own debug log messages, you can either run a debug build to see all of them or use the environment variable QT_LOGGING_RULES to specify/filter which messages you'd like to see.

Run QT_LOGGING_RULES="fernschreiber.*=true" harbour-fernschreiber to see all messages or replace the * with specific logging categories. You'll find the logging category inside the corresponding .cpp file for backend usage or you can use JS to only see frontend messages.

You can append &> fernschreiber.log to the command to create a text file containing the debug messages.

Please be aware that debug messages will most likely include personal information including (but not limited to) chat content and user ids/names of yourself and all your chat partners. Do not share it publicly and, at your discretion, try to remove private info even from the parts you do share with a trusted person.

Contribute

If you want to contribute bug fixes, improvements, new features etc. please create a pull request (PR). PRs are always welcome and will be reviewed as soon as possible, but may take some time. :)

Credits

This project uses

• The Telegram Database Library (TDLib) - available on GitHub.com. Thanks for making it available under the conditions of the Boost Software License 1.0! Details about the license of TDLib in its license file.
• Emoji parsing and artwork by Twitter Emoji (Twemoji), copyright 2018 Twitter, Inc and other contributors, Code licensed under the MIT License, Graphics licensed under CC-BY 4.0
• Animated sticker parsing and animation by rlottie, copyright 2020 Samsung Electronics Co., Ltd. and other contributors, Code licensed under the MIT License, some rlottie components licensed under other licenses.
• Reverse geocoding for location attachments by OpenStreetMap Nominatim.

Thanks to the maintainers of the used components and - again - all contributors to Fernschreiber!