Python plugin: Make account name and address read-only attributes
[claws.git] / src / plugins / python / accounttype.c
1 /* Python plugin for Claws-Mail
2  * Copyright (C) 2013 Holger Berndt <hb@claws-mail.org>
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation; either version 3 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program. If not, see <http://www.gnu.org/licenses/>.
16  */
17
18 #ifdef HAVE_CONFIG_H
19 #  include "config.h"
20 #  include "claws-features.h"
21 #endif
22
23 #include "accounttype.h"
24
25 #include <structmember.h>
26
27 typedef struct {
28     PyObject_HEAD
29     PyObject *account_name;
30     PyObject *address;
31     PrefsAccount *account;
32 } clawsmail_AccountObject;
33
34 static int Account_init(clawsmail_AccountObject *self, PyObject *args, PyObject *kwds)
35 {
36   Py_INCREF(Py_None);
37   self->account_name = Py_None;
38
39   Py_INCREF(Py_None);
40   self->address = Py_None;
41
42   self->account = NULL;
43   return 0;
44 }
45
46
47 static void Account_dealloc(clawsmail_AccountObject* self)
48 {
49   Py_XDECREF(self->account_name);
50   Py_XDECREF(self->address);
51
52   self->ob_type->tp_free((PyObject*)self);
53 }
54
55 static PyObject* Account_str(PyObject *self)
56 {
57   PyObject *str;
58   str = PyString_FromString("Account: ");
59   if(str == NULL)
60     return NULL;
61   PyString_ConcatAndDel(&str, PyObject_GetAttrString(self, "account_name"));
62
63   return str;
64 }
65
66 static PyObject* get_account_name(clawsmail_AccountObject *self, void *closure)
67 {
68   Py_INCREF(self->account_name);
69   return self->account_name;
70 }
71
72 static PyObject* get_address(clawsmail_AccountObject *self, void *closure)
73 {
74   Py_INCREF(self->address);
75   return self->address;
76 }
77
78 static PyMethodDef Account_methods[] = {
79     {NULL}
80 };
81
82 static PyGetSetDef Account_getset[] = {
83     {"account_name", (getter)get_account_name, (setter)NULL,
84       "account_name - name of the account", NULL},
85
86     {"address", (getter)get_address, (setter)NULL,
87      "address - address of the account", NULL},
88
89     {NULL}
90 };
91
92 static PyTypeObject clawsmail_AccountType = {
93     PyObject_HEAD_INIT(NULL)
94     0,                         /* ob_size*/
95     "clawsmail.Account",       /* tp_name*/
96     sizeof(clawsmail_AccountObject), /* tp_basicsize*/
97     0,                         /* tp_itemsize*/
98     (destructor)Account_dealloc, /* tp_dealloc*/
99     0,                         /* tp_print*/
100     0,                         /* tp_getattr*/
101     0,                         /* tp_setattr*/
102     0,                         /* tp_compare*/
103     0,                         /* tp_repr*/
104     0,                         /* tp_as_number*/
105     0,                         /* tp_as_sequence*/
106     0,                         /* tp_as_mapping*/
107     0,                         /* tp_hash */
108     0,                         /* tp_call*/
109     Account_str,               /* tp_str*/
110     0,                         /* tp_getattro*/
111     0,                         /* tp_setattro*/
112     0,                         /* tp_as_buffer*/
113     Py_TPFLAGS_DEFAULT,        /* tp_flags*/
114     "Account objects.\n\n"     /* tp_doc */
115     "Do not construct objects of this type yourself.",
116     0,                         /* tp_traverse */
117     0,                         /* tp_clear */
118     0,                         /* tp_richcompare */
119     0,                         /* tp_weaklistoffset */
120     0,                         /* tp_iter */
121     0,                         /* tp_iternext */
122     Account_methods,           /* tp_methods */
123     0,                         /* tp_members */
124     Account_getset,            /* tp_getset */
125     0,                         /* tp_base */
126     0,                         /* tp_dict */
127     0,                         /* tp_descr_get */
128     0,                         /* tp_descr_set */
129     0,                         /* tp_dictoffset */
130     (initproc)Account_init,    /* tp_init */
131     0,                         /* tp_alloc */
132     0,                         /* tp_new */
133 };
134
135
136 gboolean cmpy_add_account(PyObject *module)
137 {
138   clawsmail_AccountType.tp_new = PyType_GenericNew;
139   if(PyType_Ready(&clawsmail_AccountType) < 0)
140     return FALSE;
141
142   Py_INCREF(&clawsmail_AccountType);
143   return (PyModule_AddObject(module, "Account", (PyObject*)&clawsmail_AccountType) == 0);
144 }
145
146 static gboolean update_members(clawsmail_AccountObject *self, PrefsAccount *account)
147 {
148   if(account->account_name) {
149     Py_XDECREF(self->account_name);
150     self->account_name = PyString_FromString(account->account_name);
151     if(!self->account_name)
152       goto err;
153   }
154
155   if(account->address) {
156     Py_XDECREF(self->address);
157     self->address = PyString_FromString(account->address);
158     if(!self->address)
159       goto err;
160   }
161
162   self->account = account;
163
164   return TRUE;
165 err:
166   Py_XDECREF(self->account_name);
167   Py_XDECREF(self->address);
168   return FALSE;
169 }
170
171 PyObject* clawsmail_account_new(PrefsAccount *account)
172 {
173   clawsmail_AccountObject *ff;
174
175   if(!account)
176     return NULL;
177
178   ff = (clawsmail_AccountObject*) PyObject_CallObject((PyObject*) &clawsmail_AccountType, NULL);
179   if(!ff)
180     return NULL;
181
182   if(update_members(ff, account))
183     return (PyObject*)ff;
184   else {
185     Py_XDECREF(ff);
186     return NULL;
187   }
188 }