apps/irssi/src/perl/perl-core.c

   1 /*
   2  perl-core.c : irssi
   3
   4     Copyright (C) 1999-2001 Timo Sirainen
   5
   6     This program is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     This program is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with this program; if not, write to the Free Software
  18     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19 */
  20
  21 #define NEED_PERL_H
  22 #include "module.h"
  23 #include "modules.h"
  24 #include "core.h"
  25 #include "signals.h"
  26 #include "misc.h"
  27 #include "settings.h"
  28 #include "lib-config/iconfig.h" /* FIXME: remove before .99 */
  29
  30 #include "perl-core.h"
  31 #include "perl-common.h"
  32 #include "perl-signals.h"
  33 #include "perl-sources.h"
  34
  35 #include "XSUB.h"
  36 #include "irssi-core.pl.h"
  37
  38 /* For compatibility with perl 5.004 and older */
  39 #ifndef HAVE_PL_PERL
  40 #  define PL_perl_destruct_level perl_destruct_level
  41 #endif
  42
  43 GSList *perl_scripts;
  44 PerlInterpreter *my_perl;
  45
  46 static int print_script_errors;
  47
  48 #define IS_PERL_SCRIPT(file) \
  49         (strlen(file) > 3 && strcmp(file+strlen(file)-3, ".pl") == 0)
  50
  51 static void perl_script_destroy_package(PERL_SCRIPT_REC *script)
  52 {
  53         dSP;
  54
  55         ENTER;
  56         SAVETMPS;
  57
  58         PUSHMARK(SP);
  59         XPUSHs(sv_2mortal(new_pv(script->package)));
  60         PUTBACK;
  61
  62         perl_call_pv("Irssi::Core::destroy", G_VOID|G_EVAL|G_DISCARD);
  63
  64         SPAGAIN;
  65
  66         PUTBACK;
  67         FREETMPS;
  68         LEAVE;
  69 }
  70
  71 static void perl_script_destroy(PERL_SCRIPT_REC *script)
  72 {
  73         perl_scripts = g_slist_remove(perl_scripts, script);
  74
  75         signal_emit("script destroyed", 1, script);
  76
  77         perl_signal_remove_script(script);
  78         perl_source_remove_script(script);
  79
  80         g_free(script->name);
  81         g_free(script->package);
  82         g_free_not_null(script->path);
  83         g_free_not_null(script->data);
  84         g_free(script);
  85 }
  86
  87 extern void boot_DynaLoader(pTHX_ CV* cv);
  88
  89 #if PERL_STATIC_LIBS == 1
  90 extern void boot_Irssi(CV *cv);
  91
  92 XS(boot_Irssi_Core)
  93 {
  94         dXSARGS;
  95
  96         irssi_callXS(boot_Irssi, cv, mark);
  97         irssi_boot(Irc);
  98         irssi_boot(UI);
  99         irssi_boot(TextUI);
 100         XSRETURN_YES;
 101 }
 102 #endif
 103
 104 static void xs_init(pTHX)
 105 {
 106         dXSUB_SYS;
 107
 108 #if PERL_STATIC_LIBS == 1
 109         newXS("Irssi::Core::boot_Irssi_Core", boot_Irssi_Core, __FILE__);
 110 #endif
 111
 112         /* boot the dynaloader too, if we want to use some
 113            other dynamic modules.. */
 114         newXS("DynaLoader::boot_DynaLoader", boot_DynaLoader, __FILE__);
 115 }
 116
 117 /* Initialize perl interpreter */
 118 void perl_scripts_init(void)
 119 {
 120         char *args[] = {"", "-e", "0"};
 121         char *code, *use_code;
 122
 123         perl_scripts = NULL;
 124         perl_sources_start();
 125         perl_signals_start();
 126
 127         my_perl = perl_alloc();
 128         perl_construct(my_perl);
 129
 130         perl_parse(my_perl, xs_init, 3, args, NULL);
 131 #if PERL_STATIC_LIBS == 1
 132         perl_eval_pv("Irssi::Core::boot_Irssi_Core();", TRUE);
 133 #endif
 134
 135         perl_common_start();
 136
 137         use_code = perl_get_use_list();
 138         code = g_strdup_printf(irssi_core_code, PERL_STATIC_LIBS, use_code);
 139         perl_eval_pv(code, TRUE);
 140
 141         g_free(code);
 142         g_free(use_code);
 143 }
 144
 145 /* Destroy all perl scripts and deinitialize perl interpreter */
 146 void perl_scripts_deinit(void)
 147 {
 148         if (my_perl == NULL)
 149                 return;
 150
 151         /* unload all scripts */
 152         while (perl_scripts != NULL)
 153                 perl_script_unload(perl_scripts->data);
 154
 155         signal_emit("perl scripts deinit", 0);
 156
 157         perl_signals_stop();
 158         perl_sources_stop();
 159         perl_common_stop();
 160
 161         /* Unload all perl libraries loaded with dynaloader */
 162         perl_eval_pv("foreach my $lib (@DynaLoader::dl_modules) { if ($lib =~ /^Irssi\\b/) { $lib .= '::deinit();'; eval $lib; } }", TRUE);
 163         perl_eval_pv("eval { foreach my $lib (@DynaLoader::dl_librefs) { DynaLoader::dl_unload_file($lib); } }", TRUE);
 164
 165         /* perl interpreter */
 166         perl_destruct(my_perl);
 167         perl_free(my_perl);
 168         my_perl = NULL;
 169 }
 170
 171 /* Modify the script name so that all non-alphanumeric characters are
 172    translated to '_' */
 173 void script_fix_name(char *name)
 174 {
 175         char *p;
 176
 177         p = strrchr(name, '.');
 178         if (p != NULL) *p = '\0';
 179
 180         while (*name != '\0') {
 181                 if (*name != '_' && !i_isalnum(*name))
 182                         *name = '_';
 183                 name++;
 184         }
 185 }
 186
 187 static char *script_file_get_name(const char *path)
 188 {
 189         char *name;
 190
 191         name = g_strdup(g_basename(path));
 192         script_fix_name(name);
 193         return name;
 194 }
 195
 196 static char *script_data_get_name(void)
 197 {
 198         GString *name;
 199         char *ret;
 200         int n;
 201
 202         name = g_string_new(NULL);
 203         n = 1;
 204         do {
 205                 g_string_sprintf(name, "data%d", n);
 206                 n++;
 207         } while (perl_script_find(name->str) != NULL);
 208
 209         ret = name->str;
 210         g_string_free(name, FALSE);
 211         return ret;
 212 }
 213
 214 static int perl_script_eval(PERL_SCRIPT_REC *script)
 215 {
 216         dSP;
 217         char *error;
 218         int retcount;
 219         SV *ret;
 220
 221         ENTER;
 222         SAVETMPS;
 223
 224         PUSHMARK(SP);
 225         XPUSHs(sv_2mortal(new_pv(script->path != NULL ? script->path :
 226                                  script->data)));
 227         XPUSHs(sv_2mortal(new_pv(script->name)));
 228         PUTBACK;
 229
 230         retcount = perl_call_pv(script->path != NULL ?
 231                                 "Irssi::Core::eval_file" :
 232                                 "Irssi::Core::eval_data",
 233                                 G_EVAL|G_SCALAR);
 234         SPAGAIN;
 235
 236         error = NULL;
 237         if (SvTRUE(ERRSV)) {
 238                 error = SvPV(ERRSV, PL_na);
 239
 240                 if (error != NULL) {
 241                         error = g_strdup(error);
 242                         signal_emit("script error", 2, script, error);
 243                         g_free(error);
 244                 }
 245         } else if (retcount > 0) {
 246                 /* if script returns 0, it means the script wanted to die
 247                    immediately without any error message */
 248                 ret = POPs;
 249                 if (ret != &PL_sv_undef && SvIOK(ret) && SvIV(ret) == 0)
 250                         error = "";
 251         }
 252
 253         PUTBACK;
 254         FREETMPS;
 255         LEAVE;
 256
 257         return error == NULL;
 258 }
 259
 260 /* NOTE: name must not be free'd */
 261 static PERL_SCRIPT_REC *script_load(char *name, const char *path,
 262                                     const char *data)
 263 {
 264         PERL_SCRIPT_REC *script;
 265
 266         /* if there's a script with a same name, destroy it */
 267         script = perl_script_find(name);
 268         if (script != NULL)
 269                 perl_script_destroy(script);
 270
 271         script = g_new0(PERL_SCRIPT_REC, 1);
 272         script->name = name;
 273         script->package = g_strdup_printf("Irssi::Script::%s", name);
 274         script->path = g_strdup(path);
 275         script->data = g_strdup(data);
 276
 277         perl_scripts = g_slist_append(perl_scripts, script);
 278         signal_emit("script created", 1, script);
 279
 280         if (!perl_script_eval(script))
 281                 script = NULL; /* the script is destroyed in "script error" signal */
 282         return script;
 283 }
 284
 285 /* Load a perl script, path must be a full path. */
 286 PERL_SCRIPT_REC *perl_script_load_file(const char *path)
 287 {
 288         char *name;
 289
 290         g_return_val_if_fail(path != NULL, NULL);
 291
 292         name = script_file_get_name(path);
 293         return script_load(name, path, NULL);
 294 }
 295
 296 /* Load a perl script from given data */
 297 PERL_SCRIPT_REC *perl_script_load_data(const char *data)
 298 {
 299         char *name;
 300
 301         g_return_val_if_fail(data != NULL, NULL);
 302
 303         name = script_data_get_name();
 304         return script_load(name, NULL, data);
 305 }
 306
 307 /* Unload perl script */
 308 void perl_script_unload(PERL_SCRIPT_REC *script)
 309 {
 310         g_return_if_fail(script != NULL);
 311
 312         perl_script_destroy_package(script);
 313         perl_script_destroy(script);
 314 }
 315
 316 /* Find loaded script by name */
 317 PERL_SCRIPT_REC *perl_script_find(const char *name)
 318 {
 319         GSList *tmp;
 320
 321         g_return_val_if_fail(name != NULL, NULL);
 322
 323         for (tmp = perl_scripts; tmp != NULL; tmp = tmp->next) {
 324                 PERL_SCRIPT_REC *rec = tmp->data;
 325
 326                 if (strcmp(rec->name, name) == 0)
 327                         return rec;
 328         }
 329
 330         return NULL;
 331 }
 332
 333 /* Find loaded script by package */
 334 PERL_SCRIPT_REC *perl_script_find_package(const char *package)
 335 {
 336         GSList *tmp;
 337
 338         g_return_val_if_fail(package != NULL, NULL);
 339
 340         for (tmp = perl_scripts; tmp != NULL; tmp = tmp->next) {
 341                 PERL_SCRIPT_REC *rec = tmp->data;
 342
 343                 if (strcmp(rec->package, package) == 0)
 344                         return rec;
 345         }
 346
 347         return NULL;
 348 }
 349
 350 /* Returns full path for the script */
 351 char *perl_script_get_path(const char *name)
 352 {
 353         struct stat statbuf;
 354         char *file, *path;
 355
 356         if (g_path_is_absolute(name) || (name[0] == '~' && name[1] == '/')) {
 357                 /* full path specified */
 358                 return convert_home(name);
 359         }
 360
 361         /* add .pl suffix if it's missing */
 362         file = IS_PERL_SCRIPT(name) ? g_strdup(name) :
 363                 g_strdup_printf("%s.pl", name);
 364
 365         /* check from ~/.irssi/scripts/ */
 366         path = g_strdup_printf("%s/scripts/%s", get_irssi_dir(), file);
 367         if (stat(path, &statbuf) != 0) {
 368                 /* check from SCRIPTDIR */
 369                 g_free(path);
 370                 path = g_strdup_printf(SCRIPTDIR"/%s", file);
 371                 if (stat(path, &statbuf) != 0)
 372                         path = NULL;
 373         }
 374         g_free(file);
 375         return path;
 376 }
 377
 378 /* If core should handle printing script errors */
 379 void perl_core_print_script_error(int print)
 380 {
 381         print_script_errors = print;
 382 }
 383
 384 /* Returns the perl module's API version. */
 385 int perl_get_api_version(void)
 386 {
 387         return IRSSI_PERL_API_VERSION;
 388 }
 389
 390 static void perl_scripts_autorun(void)
 391 {
 392         DIR *dirp;
 393         struct dirent *dp;
 394         struct stat statbuf;
 395         char *path, *fname;
 396
 397         /* run *.pl scripts from ~/.irssi/scripts/autorun/ */
 398         path = g_strdup_printf("%s/scripts/autorun", get_irssi_dir());
 399         dirp = opendir(path);
 400         if (dirp == NULL) {
 401                 g_free(path);
 402                 return;
 403         }
 404
 405         while ((dp = readdir(dirp)) != NULL) {
 406                 if (!IS_PERL_SCRIPT(dp->d_name))
 407                         continue;
 408
 409                 fname = g_strdup_printf("%s/%s", path, dp->d_name);
 410                 if (stat(fname, &statbuf) == 0 && !S_ISDIR(statbuf.st_mode))
 411                         perl_script_load_file(fname);
 412                 g_free(fname);
 413         }
 414         closedir(dirp);
 415         g_free(path);
 416 }
 417
 418 static void sig_script_error(PERL_SCRIPT_REC *script, const char *error)
 419 {
 420         char *str;
 421
 422         if (print_script_errors) {
 423                 str = g_strdup_printf("Script '%s' error:",
 424                                       script == NULL ? "??" : script->name);
 425                 signal_emit("gui dialog", 2, "error", str);
 426                 signal_emit("gui dialog", 2, "error", error);
 427                 g_free(str);
 428         }
 429
 430         if (script != NULL) {
 431                 perl_script_unload(script);
 432                 signal_stop();
 433         }
 434 }
 435
 436 static void sig_autorun(void)
 437 {
 438         signal_remove("irssi init finished", (SIGNAL_FUNC) sig_autorun);
 439
 440         perl_scripts_autorun();
 441 }
 442
 443 void perl_core_init(void)
 444 {
 445         print_script_errors = 1;
 446         settings_add_str("perl", "perl_use_lib", PERL_USE_LIB);
 447
 448         /*PL_perl_destruct_level = 1; - this crashes with some people.. */
 449         perl_signals_init();
 450         signal_add_last("script error", (SIGNAL_FUNC) sig_script_error);
 451
 452         perl_scripts_init();
 453
 454         if (irssi_init_finished)
 455                 perl_scripts_autorun();
 456         else {
 457                 signal_add("irssi init finished", (SIGNAL_FUNC) sig_autorun);
 458                 settings_check();
 459         }
 460
 461         module_register("perl", "core");
 462 }
 463
 464 void perl_core_deinit(void)
 465 {
 466         perl_signals_deinit();
 467         perl_scripts_deinit();
 468
 469         signal_remove("script error", (SIGNAL_FUNC) sig_script_error);
 470 }