src/extension/init.cpp

   1 /*
   2  * This is what gets executed to initialize all of the modules.  For
   3  * the internal modules this invovles executing their initialization
   4  * functions, for external ones it involves reading their .spmodule
   5  * files and bringing them into Sodipodi.
   6  *
   7  * Authors:
   8  *   Ted Gould <ted@gould.cx>
   9  *
  10  * Copyright (C) 2002-2004 Authors
  11  *
  12  * Released under GNU GPL, read the file 'COPYING' for more information
  13  */
  14
  15 #ifdef HAVE_CONFIG_H
  16 # include "config.h"
  17 #endif
  18 #include "path-prefix.h"
  19
  20
  21 #include "inkscape.h"
  22 #include <glibmm/i18n.h>
  23
  24 #include "system.h"
  25 #include "db.h"
  26 #include "internal/svgz.h"
  27 #include "internal/ps.h"
  28 #ifdef HAVE_CAIRO_PDF
  29 # include "internal/pdf-cairo.h"
  30 #endif
  31 #ifdef WIN32
  32 # include "internal/win32.h"
  33 # include "internal/emf-win32-inout.h"
  34 # include "internal/emf-win32-print.h"
  35 #endif
  36 #include "internal/ps-out.h"
  37 #ifdef HAVE_CAIRO_PDF
  38 # include "internal/cairo-pdf-out.h"
  39 # include "internal/cairo-renderer-pdf-out.h"
  40 # include "internal/cairo-png-out.h"
  41 # include "internal/cairo-ps-out.h"
  42 #endif
  43 #ifdef HAVE_POPPLER
  44 # include "internal/pdfinput/pdf-input.h"
  45 #endif
  46 #ifdef HAVE_POPPLER_GLIB
  47 # include "internal/pdf-input-cairo.h"
  48 #endif
  49 #include "internal/pov-out.h"
  50 #include "internal/odf.h"
  51 #include "internal/latex-pstricks-out.h"
  52 #include "internal/latex-pstricks.h"
  53 #include "internal/eps-out.h"
  54 #include "internal/gdkpixbuf-input.h"
  55 #include "internal/bluredge.h"
  56 #include "internal/gimpgrad.h"
  57 #include "internal/grid.h"
  58 #ifdef WITH_LIBWPG
  59 #include "internal/wpg-input.h"
  60 #endif
  61 #include "prefs-utils.h"
  62 #include "io/sys.h"
  63
  64 #ifdef WITH_IMAGE_MAGICK
  65 #include "internal/bitmap/adaptiveThreshold.h"
  66 #include "internal/bitmap/addNoise.h"
  67 #include "internal/bitmap/blur.h"
  68 #include "internal/bitmap/channel.h"
  69 #include "internal/bitmap/charcoal.h"
  70 #include "internal/bitmap/colorize.h"
  71 #include "internal/bitmap/contrast.h"
  72 #include "internal/bitmap/cycleColormap.h"
  73 #include "internal/bitmap/despeckle.h"
  74 #include "internal/bitmap/edge.h"
  75 #include "internal/bitmap/emboss.h"
  76 #include "internal/bitmap/enhance.h"
  77 #include "internal/bitmap/equalize.h"
  78 #include "internal/bitmap/gaussianBlur.h"
  79 #include "internal/bitmap/implode.h"
  80 #include "internal/bitmap/level.h"
  81 #include "internal/bitmap/levelChannel.h"
  82 #include "internal/bitmap/medianFilter.h"
  83 #include "internal/bitmap/modulate.h"
  84 #include "internal/bitmap/negate.h"
  85 #include "internal/bitmap/normalize.h"
  86 #include "internal/bitmap/oilPaint.h"
  87 #include "internal/bitmap/opacity.h"
  88 #include "internal/bitmap/raise.h"
  89 #include "internal/bitmap/reduceNoise.h"
  90 #include "internal/bitmap/sample.h"
  91 #include "internal/bitmap/shade.h"
  92 #include "internal/bitmap/sharpen.h"
  93 #include "internal/bitmap/solarize.h"
  94 #include "internal/bitmap/spread.h"
  95 #include "internal/bitmap/swirl.h"
  96 //#include "internal/bitmap/threshold.h"
  97 #include "internal/bitmap/unsharpmask.h"
  98 #include "internal/bitmap/wave.h"
  99 #endif /* WITH_IMAGE_MAGICK */
 100
 101 #include "internal/filter/filter.h"
 102
 103 extern gboolean inkscape_app_use_gui( Inkscape::Application const *app );
 104
 105 namespace Inkscape {
 106 namespace Extension {
 107
 108 /** This is the extention that all files are that are pulled from
 109     the extension directory and parsed */
 110 #define SP_MODULE_EXTENSION  "inx"
 111
 112 static void build_module_from_dir(gchar const *dirname);
 113 static void check_extensions();
 114
 115 /**
 116  * \return    none
 117  * \brief     Examines the given string preference and checks to see
 118  *            that at least one of the registered extensions matches
 119  *            it.  If not, a default is assigned.
 120  * \param     pref_path        Preference path to load
 121  * \param     pref_attr        Attribute to load from the preference
 122  * \param     pref_default     Default string to set
 123  * \param     extension_family List of extensions to search
 124  */
 125 static void
 126 update_pref(gchar const *pref_path, gchar const *pref_attr,
 127             gchar const *pref_default) // , GSList *extension_family)
 128 {
 129     gchar const *pref = prefs_get_string_attribute(pref_path,pref_attr);
 130     /*
 131     gboolean missing=TRUE;
 132     for (GSList *list = extension_family; list; list = g_slist_next(list)) {
 133         g_assert( list->data );
 134
 135         Inkscape::Extension *extension;
 136         extension = reinterpret_cast<Inkscape::Extension *>(list->data);
 137
 138         if (!strcmp(extension->get_id(),pref)) missing=FALSE;
 139     }
 140     */
 141     if (!Inkscape::Extension::db.get( pref ) /*missing*/) {
 142         prefs_set_string_attribute(pref_path, pref_attr, pref_default);
 143     }
 144 }
 145
 146 /**
 147  * Invokes the init routines for internal modules.
 148  *
 149  * This should be a list of all the internal modules that need to initialized.  This is just a
 150  * convinent place to put them.  Also, this function calls build_module_from_dir to parse the
 151  * Inkscape extensions directory.
 152  */
 153 void
 154 init()
 155 {
 156     /* TODO: Change to Internal */
 157     Internal::Svg::init();
 158     Internal::Svgz::init();
 159     Internal::PsOutput::init();
 160     Internal::EpsOutput::init();
 161     Internal::PrintPS::init();
 162 #ifdef HAVE_CAIRO_PDF
 163     Internal::CairoPdfOutput::init();
 164     Internal::PrintCairoPDF::init();
 165     if (0) {
 166     Internal::CairoRendererPdfOutput::init();
 167     Internal::CairoRendererOutput::init();
 168     }
 169     Internal::CairoPsOutput::init();
 170 #endif
 171 #ifdef HAVE_POPPLER
 172     Internal::PdfInput::init();
 173 #endif
 174 #ifdef HAVE_POPPLER_GLIB
 175     if (1) {
 176     Internal::PdfInputCairo::init();
 177     }
 178 #endif
 179 #ifdef WIN32
 180     Internal::PrintWin32::init();
 181     Internal::PrintEmfWin32::init();
 182     Internal::EmfWin32::init();
 183 #endif
 184     Internal::PovOutput::init();
 185     Internal::OdfOutput::init();
 186     Internal::PrintLatex::init();
 187     Internal::LatexOutput::init();
 188 #ifdef WITH_LIBWPG
 189     Internal::WpgInput::init();
 190 #endif
 191
 192     /* Effects */
 193     Internal::BlurEdge::init();
 194     Internal::GimpGrad::init();
 195     Internal::Grid::init();
 196
 197     /* Raster Effects */
 198 #ifdef WITH_IMAGE_MAGICK
 199     Internal::Bitmap::AdaptiveThreshold::init();
 200     Internal::Bitmap::AddNoise::init();
 201     Internal::Bitmap::Blur::init();
 202     Internal::Bitmap::Channel::init();
 203     Internal::Bitmap::Charcoal::init();
 204     Internal::Bitmap::Colorize::init();
 205     Internal::Bitmap::Contrast::init();
 206     Internal::Bitmap::CycleColormap::init();
 207     Internal::Bitmap::Edge::init();
 208     Internal::Bitmap::Despeckle::init();
 209     Internal::Bitmap::Emboss::init();
 210     Internal::Bitmap::Enhance::init();
 211     Internal::Bitmap::Equalize::init();
 212     Internal::Bitmap::GaussianBlur::init();
 213     Internal::Bitmap::Implode::init();
 214     Internal::Bitmap::Level::init();
 215     Internal::Bitmap::LevelChannel::init();
 216     Internal::Bitmap::MedianFilter::init();
 217     Internal::Bitmap::Modulate::init();
 218     Internal::Bitmap::Negate::init();
 219     Internal::Bitmap::Normalize::init();
 220     Internal::Bitmap::OilPaint::init();
 221     Internal::Bitmap::Opacity::init();
 222     Internal::Bitmap::Raise::init();
 223     Internal::Bitmap::ReduceNoise::init();
 224     Internal::Bitmap::Sample::init();
 225     Internal::Bitmap::Shade::init();
 226     Internal::Bitmap::Sharpen::init();
 227     Internal::Bitmap::Solarize::init();
 228     Internal::Bitmap::Spread::init();
 229     Internal::Bitmap::Swirl::init();
 230     //Internal::Bitmap::Threshold::init();
 231     Internal::Bitmap::Unsharpmask::init();
 232     Internal::Bitmap::Wave::init();
 233 #endif /* WITH_IMAGE_MAGICK */
 234
 235         Internal::Filter::Filter::filters_all();
 236
 237     /* Load search path for extensions */
 238     if (Inkscape::Extension::Extension::search_path.size() == 0)
 239     {
 240         Inkscape::Extension::Extension::search_path.push_back(profile_path("extensions"));
 241
 242 #ifdef WIN32
 243 /*
 244  * The native Windows Save dialogs change the current directory of Inkscape to the path selected in the dialog
 245  * Putting relative paths in the search_path breaks things after the Save dialog ha been shown
 246  * Especially the XAML-save: https://bugs.launchpad.net/inkscape/+bug/168896
 247  * This code inserts an absolute path based on the current working dir when Inkscape starts.
 248  * Only included in WIN32 to avoid messing around with other platforms for the moment
 249  * After testing on other platforms this code can be enabled on other platforms (it "should" not break anything).
 250  */
 251         gchar * cwd = g_get_current_dir();
 252         gchar * fname = g_build_filename(
 253        cwd,
 254        g_strdup(INKSCAPE_EXTENSIONDIR),
 255        NULL);
 256     Glib::ustring filename = fname;
 257     Inkscape::Extension::Extension::search_path.push_back(g_strdup(filename.c_str()));
 258     g_free(cwd);
 259     g_free(fname);
 260 #else
 261         Inkscape::Extension::Extension::search_path.push_back(g_strdup(INKSCAPE_EXTENSIONDIR));
 262 #endif
 263
 264     }
 265
 266     for (unsigned int i=0; i<Inkscape::Extension::Extension::search_path.size(); i++) {
 267         build_module_from_dir(Inkscape::Extension::Extension::search_path[i]);
 268     }
 269
 270     /* this is at the very end because it has several catch-alls
 271      * that are possibly over-ridden by other extensions (such as
 272      * svgz)
 273      */
 274     Internal::GdkpixbufInput::init();
 275
 276     /* now we need to check and make sure everyone is happy */
 277     check_extensions();
 278
 279     /* This is a hack to deal with updating saved outdated module
 280      * names in the prefs...
 281      */
 282     update_pref("dialogs.save_as", "default",
 283                 SP_MODULE_KEY_OUTPUT_SVG_INKSCAPE
 284                 // Inkscape::Extension::db.get_output_list()
 285         );
 286 }
 287
 288 /**
 289  * \return    none
 290  * \brief     This function parses a directory for files of SP_MODULE_EXTENSION
 291  *            type and loads them.
 292  * \param     dirname  The directory that should be searched for modules
 293  *
 294  * Here is just a basic function that moves through a directory.  It looks at every entry, and
 295  * compares its filename with SP_MODULE_EXTENSION.  Of those that pass, build_from_file is called
 296  * with their filenames.
 297  */
 298 static void
 299 build_module_from_dir(gchar const *dirname)
 300 {
 301     if (!dirname) {
 302         g_warning(_("Null external module directory name.  Modules will not be loaded."));
 303         return;
 304     }
 305
 306     if (!Glib::file_test(std::string(dirname), Glib::FILE_TEST_EXISTS | Glib::FILE_TEST_IS_DIR)) {
 307         return;
 308     }
 309
 310     //# Hopefully doing this the Glib way is portable
 311
 312     GError *err;
 313     GDir *directory = g_dir_open(dirname, 0, &err);
 314     if (!directory) {
 315         gchar *safeDir = Inkscape::IO::sanitizeString(dirname);
 316         g_warning(_("Modules directory (%s) is unavailable.  External modules in that directory will not be loaded."), safeDir);
 317         g_free(safeDir);
 318         return;
 319     }
 320
 321     gchar *filename;
 322     while ((filename = (gchar *)g_dir_read_name(directory)) != NULL) {
 323
 324         if (strlen(filename) < strlen(SP_MODULE_EXTENSION)) {
 325             continue;
 326         }
 327
 328         if (strcmp(SP_MODULE_EXTENSION, filename + (strlen(filename) - strlen(SP_MODULE_EXTENSION)))) {
 329             continue;
 330         }
 331
 332         gchar *pathname = g_strdup_printf("%s/%s", dirname, filename);
 333         build_from_file(pathname);
 334         g_free(pathname);
 335     }
 336
 337     g_dir_close(directory);
 338 }
 339
 340
 341 static void
 342 check_extensions_internal(Extension *in_plug, gpointer in_data)
 343 {
 344     int *count = (int *)in_data;
 345
 346     if (in_plug == NULL) return;
 347     if (!in_plug->deactivated() && !in_plug->check()) {
 348          in_plug->deactivate();
 349         (*count)++;
 350     }
 351 }
 352
 353 static void
 354 check_extensions()
 355 {
 356     int count = 1;
 357     bool anyfail = false;
 358     // int pass = 0;
 359
 360     Inkscape::Extension::Extension::error_file_open();
 361     while (count != 0) {
 362         count = 0;
 363         db.foreach(check_extensions_internal, (gpointer)&count);
 364         if (count != 0) anyfail = true;
 365     }
 366     Inkscape::Extension::Extension::error_file_close();
 367 }
 368
 369 } } /* namespace Inkscape::Extension */
 370
 371
 372 /*
 373   Local Variables:
 374   mode:c++
 375   c-file-style:"stroustrup"
 376   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
 377   indent-tabs-mode:nil
 378   fill-column:99
 379   End:
 380 */
 381 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :