Get the Delta Chat plugin to show up in pidgin
This commit is contained in:
17
Makefile
Normal file
17
Makefile
Normal file
@@ -0,0 +1,17 @@
|
||||
CC ?= gcc
|
||||
PREFIX ?= /usr/local
|
||||
|
||||
libdelta.so: *.c *.h
|
||||
$(CC) -C \
|
||||
-Wall -Wextra -Werror \
|
||||
-std=c11 \
|
||||
-shared \
|
||||
-fpic \
|
||||
$(shell pkg-config --cflags purple) \
|
||||
-o libdelta.so \
|
||||
*.c \
|
||||
-shared \
|
||||
$(shell pkg-config --libs purple)
|
||||
|
||||
clean:
|
||||
rm libdelta.so
|
||||
48
README.md
Normal file
48
README.md
Normal file
@@ -0,0 +1,48 @@
|
||||
# Delta Chat plugin for libpurple
|
||||
|
||||
## Overview
|
||||
|
||||
[Delta Chat](https://delta.chat) is an instant messaging application based on
|
||||
email - which is to say, SMTP+IMAP.
|
||||
|
||||
It doesn't have its own desktop application at present, but it does have a
|
||||
[core protocol library](https://github.com/deltachat/deltachat-core). Wrapping
|
||||
this in a libpurple plugin will allow existing desktop applications such as
|
||||
[Pidgin](https://pidgin.im) to interoperate.
|
||||
|
||||
## Build
|
||||
|
||||
Very basic instructions at present. First, `deltachat-core` isn't packaged, so
|
||||
you'll need to build and install it according to
|
||||
[these instructions](https://github.com/deltachat/deltachat-core/blob/master/README.md#build).
|
||||
|
||||
Now, you'll need the libpurple build dependencies:
|
||||
|
||||
```
|
||||
sudo apt install libpurple-dev build-essential
|
||||
```
|
||||
|
||||
Finally, run `make` to create a `libdelta.so` file.
|
||||
|
||||
## Use
|
||||
|
||||
The easiest way to use this is to copy the `libdelta.so` file into
|
||||
`~/.purple/plugins`. When running pidgin, you'll now have the option to add
|
||||
a "Delta Chat" account.
|
||||
|
||||
At present, the "Username" and "Password" account fields correspond to email
|
||||
address and password, respectively. Many important settings also show up on the
|
||||
"Advanced" tab - if left blank, the plugin will attempt to automatically detect
|
||||
the correct values, but you may need to fill some of them in manually to get
|
||||
the connection to work.
|
||||
|
||||
Run pidgin with `--debug` to see interesting output.
|
||||
|
||||
## Limitations
|
||||
|
||||
NOTHING IS DONE YET.
|
||||
|
||||
Once that's fixed:
|
||||
|
||||
There's no facility at present to import account keys, so sharing an email
|
||||
address between your mobile and desktop isn't amazing. It's high on the agenda.
|
||||
225
libdelta.c
Normal file
225
libdelta.c
Normal file
@@ -0,0 +1,225 @@
|
||||
#define PURPLE_PLUGINS
|
||||
|
||||
#include "libdelta.h"
|
||||
|
||||
#include <glib.h>
|
||||
|
||||
// All from libpurple
|
||||
#include <accountopt.h>
|
||||
#include <debug.h>
|
||||
#include <notify.h>
|
||||
#include <plugin.h>
|
||||
#include <prpl.h>
|
||||
#include <version.h>
|
||||
|
||||
#define UNUSED(x) (void)(x)
|
||||
|
||||
static void
|
||||
delta_login()
|
||||
{
|
||||
|
||||
}
|
||||
|
||||
static void
|
||||
delta_close()
|
||||
{
|
||||
|
||||
}
|
||||
|
||||
// Below the fold is libpurple plumbing. No, I don't understand it either
|
||||
|
||||
static const char *
|
||||
delta_list_icon(PurpleAccount *acct, PurpleBuddy *buddy)
|
||||
{
|
||||
UNUSED(acct);
|
||||
UNUSED(buddy);
|
||||
|
||||
return "delta";
|
||||
}
|
||||
|
||||
static void
|
||||
debug(const char *str)
|
||||
{
|
||||
purple_debug_info(PLUGIN_ID, str);
|
||||
}
|
||||
|
||||
static PurpleAccountOption *
|
||||
str_opt(const char *text, const char *name, const char *def)
|
||||
{
|
||||
return purple_account_option_string_new(text, name, def);
|
||||
}
|
||||
|
||||
static PurpleAccountOption *
|
||||
pwd_opt(const char *text, const char *name, const char *def)
|
||||
{
|
||||
PurpleAccountOption* option = str_opt(text, name, def);
|
||||
purple_account_option_set_masked(option, TRUE);
|
||||
|
||||
return option;
|
||||
}
|
||||
|
||||
static PurpleAccountOption *
|
||||
int_opt(const char *text, const char *name, int def)
|
||||
{
|
||||
return purple_account_option_int_new(text, name, def);
|
||||
}
|
||||
|
||||
static void
|
||||
delta_init_plugin(PurplePlugin *plugin)
|
||||
{
|
||||
PurplePluginProtocolInfo *extra = (PurplePluginProtocolInfo *)plugin->info->extra_info;
|
||||
GList *opts = NULL;
|
||||
|
||||
debug("Starting up\n");
|
||||
|
||||
|
||||
opts = g_list_prepend(opts, str_opt("Display Name", PLUGIN_ACCOUNT_OPT_DISPLAY_NAME, ""));
|
||||
|
||||
opts = g_list_prepend(opts, str_opt("IMAP Server Host", PLUGIN_ACCOUNT_OPT_IMAP_SERVER_HOST, ""));
|
||||
opts = g_list_prepend(opts, int_opt("IMAP Server Port", PLUGIN_ACCOUNT_OPT_IMAP_SERVER_PORT, DEFAULT_IMAP_PORT));
|
||||
opts = g_list_prepend(opts, str_opt("IMAP Username", PLUGIN_ACCOUNT_OPT_IMAP_USER, ""));
|
||||
|
||||
// These are pidgin's built-in username & password options
|
||||
// FIXME: it's not super-obvious or pleasant :/
|
||||
// opts = g_list_prepend(opts, str_opt("Email Address", PLUGIN_ACCOUNT_OPT_EMAIL_ADDRESS, ""));
|
||||
// opts = g_list_prepend(opts, pwd_opt("IMAP Password", PLUGIN_ACCOUNT_OPT_IMAP_PASS, ""));
|
||||
|
||||
opts = g_list_prepend(opts, str_opt("SMTP Server Host", PLUGIN_ACCOUNT_OPT_SMTP_SERVER_HOST, ""));
|
||||
opts = g_list_prepend(opts, int_opt("SMTP Server Port", PLUGIN_ACCOUNT_OPT_SMTP_SERVER_PORT, DEFAULT_SMTP_PORT));
|
||||
opts = g_list_prepend(opts, str_opt("SMTP Username", PLUGIN_ACCOUNT_OPT_SMTP_USER, ""));
|
||||
opts = g_list_prepend(opts, pwd_opt("SMTP Password", PLUGIN_ACCOUNT_OPT_SMTP_PASS, ""));
|
||||
|
||||
// Not exposed: server_flags, selfstatus, e2ee_enabled
|
||||
// https://deltachat.github.io/api/classmrmailbox__t.html
|
||||
|
||||
extra->protocol_options = g_list_reverse(opts);
|
||||
}
|
||||
|
||||
static void delta_destroy_plugin(PurplePlugin *plugin) {
|
||||
UNUSED(plugin);
|
||||
|
||||
debug("Shutting down\n");
|
||||
}
|
||||
|
||||
static PurplePluginProtocolInfo extra_info =
|
||||
{
|
||||
DELTA_PROTOCOL_OPTS, /* options */
|
||||
NULL, /* user_splits, initialized in matrixprpl_init() */
|
||||
NULL, /* protocol_options, initialized in matrixprpl_init() */
|
||||
{ /* icon_spec, a PurpleBuddyIconSpec */
|
||||
"svg,png,jpg,gif", /* format */
|
||||
0, /* min_width */
|
||||
0, /* min_height */
|
||||
128, /* max_width */
|
||||
128, /* max_height */
|
||||
10000, /* max_filesize */
|
||||
PURPLE_ICON_SCALE_DISPLAY, /* scale_rules */
|
||||
},
|
||||
delta_list_icon, /* list_icon */
|
||||
NULL, /* list_emblem */
|
||||
NULL, /* status_text */
|
||||
NULL, /* tooltip_text */
|
||||
NULL, /* status_types */
|
||||
NULL, /* blist_node_menu */
|
||||
NULL, /* chat_info */
|
||||
NULL, /* chat_info_defaults */
|
||||
delta_login, /* login */
|
||||
delta_close, /* close */
|
||||
NULL, /* send_im */
|
||||
NULL, /* set_info */
|
||||
NULL, /* send_typing */
|
||||
NULL, /* get_info */
|
||||
NULL, /* set_status */
|
||||
NULL, /* set_idle */
|
||||
NULL, /* change_passwd */
|
||||
NULL, /* add_buddy */
|
||||
NULL, /* add_buddies */
|
||||
NULL, /* remove_buddy */
|
||||
NULL, /* remove_buddies */
|
||||
NULL, /* add_permit */
|
||||
NULL, /* add_deny */
|
||||
NULL, /* rem_permit */
|
||||
NULL, /* rem_deny */
|
||||
NULL, /* set_permit_deny */
|
||||
NULL, /* join_chat */
|
||||
NULL, /* reject_chat */
|
||||
NULL, /* get_chat_name */
|
||||
NULL, /* chat_invite */
|
||||
NULL, /* chat_leave */
|
||||
NULL, /* chat_whisper */
|
||||
NULL, /* chat_send */
|
||||
NULL, /* keepalive */
|
||||
NULL, /* register_user */
|
||||
NULL, /* get_cb_info */
|
||||
NULL, /* get_cb_away */
|
||||
NULL, /* alias_buddy */
|
||||
NULL, /* group_buddy */
|
||||
NULL, /* rename_group */
|
||||
NULL, /* buddy_free */
|
||||
NULL, /* convo_closed */
|
||||
NULL, /* normalize */
|
||||
NULL, /* set_buddy_icon */
|
||||
NULL, /* remove_group */
|
||||
NULL, /* get_cb_real_name */
|
||||
NULL, /* set_chat_topic */
|
||||
NULL, /* find_blist_chat */
|
||||
NULL, /* roomlist_get_list */
|
||||
NULL, /* roomlist_cancel */
|
||||
NULL, /* roomlist_expand_category */
|
||||
NULL, /* can_receive_file */
|
||||
NULL, /* send_file */
|
||||
NULL, /* new_xfer */
|
||||
NULL, /* offline_message */
|
||||
NULL, /* whiteboard_prpl_ops */
|
||||
NULL, /* send_raw */
|
||||
NULL, /* roomlist_room_serialize */
|
||||
NULL, /* unregister_user */
|
||||
NULL, /* send_attention */
|
||||
NULL, /* get_attention_types */
|
||||
sizeof(PurplePluginProtocolInfo), /* struct_size */
|
||||
NULL, /* get_account_text_table */
|
||||
NULL, /* initiate_media */
|
||||
NULL, /* get_media_caps */
|
||||
NULL, /* get_moods */
|
||||
NULL, /* set_public_alias */
|
||||
NULL, /* get_public_alias */
|
||||
NULL, /* add_buddy_with_invite */
|
||||
NULL /* add_buddies_with_invite */
|
||||
};
|
||||
|
||||
|
||||
static PurplePluginInfo info = {
|
||||
PURPLE_PLUGIN_MAGIC,
|
||||
PURPLE_MAJOR_VERSION,
|
||||
PURPLE_MINOR_VERSION,
|
||||
PURPLE_PLUGIN_PROTOCOL,
|
||||
NULL, // UI requirements
|
||||
0, // flags
|
||||
NULL, // dependencies
|
||||
PURPLE_PRIORITY_DEFAULT,
|
||||
|
||||
PLUGIN_ID,
|
||||
"Delta Chat",
|
||||
"0.0.0",
|
||||
|
||||
"Delta Chat is an email-based instant messaging solution",
|
||||
"See https://delta.chat for more information",
|
||||
"Nick Thomas <delta@ur.gs>",
|
||||
"https://delta.chat",
|
||||
|
||||
NULL, // plugin_load
|
||||
NULL, // plugin_unload
|
||||
delta_destroy_plugin, // plugin_destroy
|
||||
|
||||
NULL, // ui_info
|
||||
&extra_info, // extra_info
|
||||
NULL, // prefs_info
|
||||
NULL, // actions
|
||||
|
||||
NULL, // reserved1
|
||||
NULL, // reserved2
|
||||
NULL, // reserved3
|
||||
NULL // reserved4
|
||||
};
|
||||
|
||||
PURPLE_INIT_PLUGIN(delta, delta_init_plugin, info)
|
||||
32
libdelta.h
Normal file
32
libdelta.h
Normal file
@@ -0,0 +1,32 @@
|
||||
#ifndef LIBDELTA_H
|
||||
#define LIBDELTA_H
|
||||
|
||||
#define PLUGIN_ID "prpl-delta"
|
||||
|
||||
#define DELTA_PROTOCOL_OPTS \
|
||||
OPT_PROTO_UNIQUE_CHATNAME | \
|
||||
OPT_PROTO_CHAT_TOPIC | \
|
||||
OPT_PROTO_IM_IMAGE
|
||||
|
||||
#define DEFAULT_SMTP_PORT 25
|
||||
#define DEFAULT_IMAP_PORT 143
|
||||
|
||||
|
||||
// These two will instead be the pidgin "username" and "password" options that
|
||||
// I can't seem to get rid of.
|
||||
//#define PLUGIN_ACCOUNT_OPT_ADDR "addr"
|
||||
//#define PLUGIN_ACCOUNT_OPT_IMAP_PASS "mail_pw"
|
||||
|
||||
// Share the remaining keys between purple and delta
|
||||
#define PLUGIN_ACCOUNT_OPT_DISPLAY_NAME "displayname"
|
||||
|
||||
#define PLUGIN_ACCOUNT_OPT_IMAP_SERVER_HOST "mail_server"
|
||||
#define PLUGIN_ACCOUNT_OPT_IMAP_SERVER_PORT "mail_port"
|
||||
#define PLUGIN_ACCOUNT_OPT_IMAP_USER "mail_user"
|
||||
|
||||
#define PLUGIN_ACCOUNT_OPT_SMTP_SERVER_HOST "send_server"
|
||||
#define PLUGIN_ACCOUNT_OPT_SMTP_SERVER_PORT "send_port"
|
||||
#define PLUGIN_ACCOUNT_OPT_SMTP_USER "send_user"
|
||||
#define PLUGIN_ACCOUNT_OPT_SMTP_PASS "send_pw"
|
||||
|
||||
#endif
|
||||
Reference in New Issue
Block a user