/**
* Kills the helper, closes the pipe and frees the handle
*
* @param h handle to helper to stop
* @param soft_kill if #GNUNET_YES, signals termination by closing the helper's
* stdin; #GNUNET_NO to signal termination by sending SIGTERM to helper
*/
void
GNUNET_HELPER_stop (struct GNUNET_HELPER_Handle *h,
int soft_kill)
{
h->exp_cb = NULL;
stop_helper (h, soft_kill);
GNUNET_HELPER_destroy (h);
}
/**
* Start the helper process.
*
* @param h handle to the helper process
*/
static void
start_helper (struct GNUNET_HELPER_Handle *h)
{
h->helper_in = GNUNET_DISK_pipe (GNUNET_YES, GNUNET_YES, GNUNET_YES, GNUNET_NO);
h->helper_out = GNUNET_DISK_pipe (GNUNET_YES, GNUNET_YES, GNUNET_NO, GNUNET_YES);
if ( (h->helper_in == NULL) || (h->helper_out == NULL))
{
/* out of file descriptors? try again later... */
stop_helper (h, GNUNET_NO);
h->restart_task =
GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_SECONDS,
h->retry_back_off),
&restart_task, h);
return;
}
GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
"Starting HELPER process `%s'\n",
h->binary_name);
h->fh_from_helper =
GNUNET_DISK_pipe_handle (h->helper_out, GNUNET_DISK_PIPE_END_READ);
h->fh_to_helper =
GNUNET_DISK_pipe_handle (h->helper_in, GNUNET_DISK_PIPE_END_WRITE);
h->helper_proc =
GNUNET_OS_start_process_vap (h->with_control_pipe, GNUNET_OS_INHERIT_STD_ERR,
h->helper_in, h->helper_out, NULL,
h->binary_name,
h->binary_argv);
if (NULL == h->helper_proc)
{
/* failed to start process? try again later... */
stop_helper (h, GNUNET_NO);
h->restart_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_SECONDS,
h->retry_back_off),
&restart_task, h);
return;
}
GNUNET_DISK_pipe_close_end (h->helper_out, GNUNET_DISK_PIPE_END_WRITE);
GNUNET_DISK_pipe_close_end (h->helper_in, GNUNET_DISK_PIPE_END_READ);
if (NULL != h->mst)
h->read_task = GNUNET_SCHEDULER_add_read_file (GNUNET_TIME_UNIT_FOREVER_REL,
h->fh_from_helper,
&helper_read,
h);
}
bool
SocketInstance::do_transaction (Transaction &trans, bool &ret)
{
int cmd = -1;
bool cont = false;
ret = false;
SCIM_DEBUG_IMENGINE(2) << " Do transaction:\n";
if (trans.get_command (cmd) && cmd == SCIM_TRANS_CMD_REPLY) {
while (trans.get_command (cmd)) {
switch (cmd) {
case SCIM_TRANS_CMD_SHOW_PREEDIT_STRING:
{
SCIM_DEBUG_IMENGINE(3) << " show_preedit_string ()\n";
show_preedit_string ();
break;
}
case SCIM_TRANS_CMD_SHOW_AUX_STRING:
{
SCIM_DEBUG_IMENGINE(3) << " show_aux_string ()\n";
show_aux_string ();
break;
}
case SCIM_TRANS_CMD_SHOW_LOOKUP_TABLE:
{
SCIM_DEBUG_IMENGINE(3) << " show_lookup_table ()\n";
show_lookup_table ();
break;
}
case SCIM_TRANS_CMD_HIDE_PREEDIT_STRING:
{
SCIM_DEBUG_IMENGINE(3) << " hide_preedit_string ()\n";
hide_preedit_string ();
break;
}
case SCIM_TRANS_CMD_HIDE_AUX_STRING:
{
SCIM_DEBUG_IMENGINE(3) << " hide_aux_string ()\n";
hide_aux_string ();
break;
}
case SCIM_TRANS_CMD_HIDE_LOOKUP_TABLE:
{
SCIM_DEBUG_IMENGINE(3) << " hide_lookup_table ()\n";
hide_lookup_table ();
break;
}
case SCIM_TRANS_CMD_UPDATE_PREEDIT_CARET:
{
uint32 caret;
if (trans.get_data (caret)) {
SCIM_DEBUG_IMENGINE(3) << " update_preedit_caret (" << caret << ")\n";
update_preedit_caret (caret);
}
break;
}
case SCIM_TRANS_CMD_UPDATE_PREEDIT_STRING:
{
WideString str;
AttributeList attrs;
if (trans.get_data (str) && trans.get_data (attrs)) {
SCIM_DEBUG_IMENGINE(3) << " update_preedit_string ()\n";
update_preedit_string (str, attrs);
}
break;
}
case SCIM_TRANS_CMD_UPDATE_AUX_STRING:
{
WideString str;
AttributeList attrs;
if (trans.get_data (str) && trans.get_data (attrs)) {
SCIM_DEBUG_IMENGINE(3) << " update_aux_string ()\n";
update_aux_string (str, attrs);
}
break;
}
case SCIM_TRANS_CMD_UPDATE_LOOKUP_TABLE:
{
CommonLookupTable table;
if (trans.get_data (table)) {
SCIM_DEBUG_IMENGINE(3) << " update_lookup_table ()\n";
update_lookup_table (table);
}
break;
}
case SCIM_TRANS_CMD_COMMIT_STRING:
{
WideString str;
if (trans.get_data (str)) {
SCIM_DEBUG_IMENGINE(3) << " commit_string ()\n";
commit_string (str);
}
break;
}
case SCIM_TRANS_CMD_FORWARD_KEY_EVENT:
{
KeyEvent key;
if (trans.get_data (key)) {
SCIM_DEBUG_IMENGINE(3) << " forward_key_event ()\n";
forward_key_event (key);
}
break;
}
case SCIM_TRANS_CMD_REGISTER_PROPERTIES:
{
PropertyList proplist;
if (trans.get_data (proplist)) {
SCIM_DEBUG_IMENGINE(3) << " register_properties ()\n";
// Load icon files of these properties from remote SocketFrontEnd.
for (PropertyList::iterator it = proplist.begin (); it != proplist.end (); ++it)
it->set_icon (global->load_icon (it->get_icon ()));
register_properties (proplist);
}
break;
}
case SCIM_TRANS_CMD_UPDATE_PROPERTY:
{
Property prop;
if (trans.get_data (prop)) {
SCIM_DEBUG_IMENGINE(3) << " update_property ()\n";
// Load the icon file of this property from remote SocketFrontEnd.
prop.set_icon (global->load_icon (prop.get_icon ()));
update_property (prop);
}
break;
}
case SCIM_TRANS_CMD_BEEP:
{
SCIM_DEBUG_IMENGINE(3) << " beep ()\n";
beep ();
break;
}
case SCIM_TRANS_CMD_START_HELPER:
{
String helper_uuid;
if (trans.get_data (helper_uuid)) {
SCIM_DEBUG_IMENGINE(3) << " start_helper (" << helper_uuid << ")\n";
start_helper (helper_uuid);
}
break;
}
case SCIM_TRANS_CMD_STOP_HELPER:
{
String helper_uuid;
if (trans.get_data (helper_uuid)) {
SCIM_DEBUG_IMENGINE(3) << " stop_helper (" << helper_uuid << ")\n";
stop_helper (helper_uuid);
}
break;
}
case SCIM_TRANS_CMD_SEND_HELPER_EVENT:
{
String helper_uuid;
Transaction temp_trans;
if (trans.get_data (helper_uuid) && trans.get_data (temp_trans)) {
SCIM_DEBUG_IMENGINE(3) << " send_helper_event (" << helper_uuid << ")\n";
send_helper_event (helper_uuid, temp_trans);
}
break;
}
case SCIM_TRANS_CMD_OK:
{
SCIM_DEBUG_IMENGINE(3) << " ret = true\n";
ret = true;
break;
}
case SCIM_TRANS_CMD_GET_SURROUNDING_TEXT:
{
WideString text;
int cursor;
uint32 maxlen_before;
uint32 maxlen_after;
Transaction temp_trans;
if (trans.get_data (maxlen_before) && trans.get_data (maxlen_after)) {
global->init_transaction (temp_trans);
if (get_surrounding_text (text, cursor, (int) maxlen_before, (int) maxlen_after)) {
temp_trans.put_command (SCIM_TRANS_CMD_GET_SURROUNDING_TEXT);
temp_trans.put_data (text);
temp_trans.put_data ((uint32) cursor);
} else {
temp_trans.put_command (SCIM_TRANS_CMD_FAIL);
}
global->send_transaction (temp_trans);
}
cont = true;
break;
}
case SCIM_TRANS_CMD_DELETE_SURROUNDING_TEXT:
{
uint32 offset;
uint32 len;
Transaction temp_trans;
if (trans.get_data (offset) && trans.get_data (len)) {
global->init_transaction (temp_trans);
if (delete_surrounding_text ((int) offset, (int) len)) {
temp_trans.put_command (SCIM_TRANS_CMD_DELETE_SURROUNDING_TEXT);
temp_trans.put_command (SCIM_TRANS_CMD_OK);
} else {
temp_trans.put_command (SCIM_TRANS_CMD_FAIL);
}
global->send_transaction (temp_trans);
}
cont = true;
break;
}
default:
SCIM_DEBUG_IMENGINE(3) << " Strange cmd: " << cmd << "\n";;
}
}
} else {
SCIM_DEBUG_IMENGINE(3) << " Failed to get cmd: " << cmd << "\n";
}
SCIM_DEBUG_IMENGINE(2) << " End of Do transaction\n";
return cont;
}
/**
* Write to the helper-process
*
* @param cls handle to the helper process
*/
static void
helper_write (void *cls)
{
struct GNUNET_HELPER_Handle *h = cls;
struct GNUNET_HELPER_SendHandle *sh;
const char *buf;
ssize_t t;
h->write_task = NULL;
if (NULL == (sh = h->sh_head))
{
GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
"Helper write had no work!\n");
return; /* how did this happen? */
}
buf = (const char*) sh->msg;
t = GNUNET_DISK_file_write (h->fh_to_helper,
&buf[sh->wpos],
ntohs (sh->msg->size) - sh->wpos);
if (-1 == t)
{
/* On write-error, restart the helper */
GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
_("Error writing to `%s': %s\n"),
h->binary_name,
STRERROR (errno));
if (NULL != h->exp_cb)
{
h->exp_cb (h->cb_cls);
GNUNET_HELPER_stop (h, GNUNET_NO);
return;
}
GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
"Stopping and restarting helper task!\n");
stop_helper (h, GNUNET_NO);
/* Restart the helper */
h->restart_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_SECONDS,
h->retry_back_off),
&restart_task, h);
return;
}
GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
"Transmitted %u bytes to %s\n",
(unsigned int) t,
h->binary_name);
sh->wpos += t;
if (sh->wpos == ntohs (sh->msg->size))
{
GNUNET_CONTAINER_DLL_remove (h->sh_head,
h->sh_tail,
sh);
if (NULL != sh->cont)
sh->cont (sh->cont_cls, GNUNET_YES);
GNUNET_free (sh);
}
if (NULL != h->sh_head)
h->write_task = GNUNET_SCHEDULER_add_write_file (GNUNET_TIME_UNIT_FOREVER_REL,
h->fh_to_helper,
&helper_write,
h);
}
/**
* Read from the helper-process
*
* @param cls handle to the helper process
*/
static void
helper_read (void *cls)
{
struct GNUNET_HELPER_Handle *h = cls;
char buf[GNUNET_SERVER_MAX_MESSAGE_SIZE] GNUNET_ALIGN;
ssize_t t;
h->read_task = NULL;
t = GNUNET_DISK_file_read (h->fh_from_helper, &buf, sizeof (buf));
if (t < 0)
{
/* On read-error, restart the helper */
GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
_("Error reading from `%s': %s\n"),
h->binary_name,
STRERROR (errno));
if (NULL != h->exp_cb)
{
h->exp_cb (h->cb_cls);
GNUNET_HELPER_stop (h, GNUNET_NO);
return;
}
stop_helper (h, GNUNET_NO);
/* Restart the helper */
h->restart_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS,
h->retry_back_off),
&restart_task, h);
return;
}
if (0 == t)
{
/* this happens if the helper is shut down via a
signal, so it is not a "hard" error */
GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
"Got 0 bytes from helper `%s' (EOF)\n",
h->binary_name);
if (NULL != h->exp_cb)
{
h->exp_cb (h->cb_cls);
GNUNET_HELPER_stop (h, GNUNET_NO);
return;
}
stop_helper (h, GNUNET_NO);
/* Restart the helper */
h->restart_task
= GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS,
h->retry_back_off),
&restart_task, h);
return;
}
GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
"Got %u bytes from helper `%s'\n",
(unsigned int) t,
h->binary_name);
h->read_task = GNUNET_SCHEDULER_add_read_file (GNUNET_TIME_UNIT_FOREVER_REL,
h->fh_from_helper,
&helper_read, h);
if (GNUNET_SYSERR ==
GNUNET_SERVER_mst_receive (h->mst,
NULL,
buf, t,
GNUNET_NO, GNUNET_NO))
{
GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
_("Failed to parse inbound message from helper `%s'\n"),
h->binary_name);
if (NULL != h->exp_cb)
{
h->exp_cb (h->cb_cls);
GNUNET_HELPER_stop (h, GNUNET_NO);
return;
}
stop_helper (h, GNUNET_NO);
/* Restart the helper */
h->restart_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_SECONDS,
h->retry_back_off),
&restart_task, h);
return;
}
}
void PROCEDURE_TIMER::stop(void)
{
priv_gettime(&now_rep);
stop_helper();
}
void
FilterInstanceBase::filter_stop_helper (const String &helper_uuid)
{
stop_helper (helper_uuid);
}
