426 lines
13 KiB
C
426 lines
13 KiB
C
/* PIKA - Photo and Image Kooker Application
|
|
* a rebranding of The GNU Image Manipulation Program (created with heckimp)
|
|
* A derived work which may be trivial. However, any changes may be (C)2023 by Aldercone Studio
|
|
*
|
|
* Original copyright, applying to most contents (license remains unchanged):
|
|
* Copyright (C) 1995 Spencer Kimball and Peter Mattis
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
/* Webpage plug-in.
|
|
* Copyright (C) 2011 Mukund Sivaraman <muks@banu.com>.
|
|
* Portions are copyright of the author of the
|
|
* file-open-location-dialog.c code.
|
|
*/
|
|
|
|
#include "config.h"
|
|
|
|
#include <libpika/pika.h>
|
|
#include <libpika/pikaui.h>
|
|
|
|
#include <webkit2/webkit2.h>
|
|
|
|
#include "libpika/stdplugins-intl.h"
|
|
|
|
|
|
#define PLUG_IN_PROC "plug-in-web-page"
|
|
#define PLUG_IN_BINARY "web-page"
|
|
#define PLUG_IN_ROLE "pika-web-page"
|
|
#define MAX_URL_LEN 2048
|
|
|
|
|
|
typedef struct
|
|
{
|
|
PikaImage *image;
|
|
GError *error;
|
|
} WebpageResult;
|
|
|
|
typedef struct _Webpage Webpage;
|
|
typedef struct _WebpageClass WebpageClass;
|
|
|
|
struct _Webpage
|
|
{
|
|
PikaPlugIn parent_instance;
|
|
};
|
|
|
|
struct _WebpageClass
|
|
{
|
|
PikaPlugInClass parent_class;
|
|
};
|
|
|
|
|
|
#define WEBPAGE_TYPE (webpage_get_type ())
|
|
#define WEBPAGE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), WEBPAGE_TYPE, Webpage))
|
|
|
|
GType webpage_get_type (void) G_GNUC_CONST;
|
|
|
|
static GList * webpage_query_procedures (PikaPlugIn *plug_in);
|
|
static PikaProcedure * webpage_create_procedure (PikaPlugIn *plug_in,
|
|
const gchar *name);
|
|
|
|
static PikaValueArray * webpage_run (PikaProcedure *procedure,
|
|
PikaProcedureConfig *config,
|
|
gpointer run_data);
|
|
|
|
static gboolean webpage_dialog (PikaProcedure *procedure,
|
|
PikaProcedureConfig *config);
|
|
static PikaImage * webpage_capture (PikaProcedureConfig *config,
|
|
GError **error);
|
|
|
|
|
|
G_DEFINE_TYPE (Webpage, webpage, PIKA_TYPE_PLUG_IN)
|
|
|
|
PIKA_MAIN (WEBPAGE_TYPE)
|
|
DEFINE_STD_SET_I18N
|
|
|
|
|
|
static void
|
|
webpage_class_init (WebpageClass *klass)
|
|
{
|
|
PikaPlugInClass *plug_in_class = PIKA_PLUG_IN_CLASS (klass);
|
|
|
|
plug_in_class->query_procedures = webpage_query_procedures;
|
|
plug_in_class->create_procedure = webpage_create_procedure;
|
|
plug_in_class->set_i18n = STD_SET_I18N;
|
|
}
|
|
|
|
static void
|
|
webpage_init (Webpage *webpage)
|
|
{
|
|
}
|
|
|
|
static GList *
|
|
webpage_query_procedures (PikaPlugIn *plug_in)
|
|
{
|
|
return g_list_append (NULL, g_strdup (PLUG_IN_PROC));
|
|
}
|
|
|
|
static PikaProcedure *
|
|
webpage_create_procedure (PikaPlugIn *plug_in,
|
|
const gchar *name)
|
|
{
|
|
PikaProcedure *procedure = NULL;
|
|
|
|
if (! strcmp (name, PLUG_IN_PROC))
|
|
{
|
|
procedure = pika_procedure_new (plug_in, name,
|
|
PIKA_PDB_PROC_TYPE_PLUGIN,
|
|
webpage_run, NULL, NULL);
|
|
|
|
pika_procedure_set_menu_label (procedure, _("From _Webpage..."));
|
|
pika_procedure_add_menu_path (procedure, "<Image>/File/Create");
|
|
|
|
pika_procedure_set_documentation (procedure,
|
|
_("Create an image of a webpage"),
|
|
"The plug-in allows you to take a "
|
|
"screenshot of a webpage.",
|
|
name);
|
|
pika_procedure_set_attribution (procedure,
|
|
"Mukund Sivaraman <muks@banu.com>",
|
|
"2011",
|
|
"2011");
|
|
|
|
PIKA_PROC_ARG_ENUM (procedure, "run-mode",
|
|
"Run mode",
|
|
"The run mode",
|
|
PIKA_TYPE_RUN_MODE,
|
|
PIKA_RUN_INTERACTIVE,
|
|
G_PARAM_READWRITE);
|
|
|
|
PIKA_PROC_ARG_STRING (procedure, "url",
|
|
_("Enter location (_URI)"),
|
|
_("URL of the webpage to screenshot"),
|
|
"https://heckin.technology/AlderconeStudio/PIKApp/",
|
|
G_PARAM_READWRITE);
|
|
|
|
PIKA_PROC_ARG_INT (procedure, "width",
|
|
_("_Width (pixels)"),
|
|
_("The width of the screenshot (in pixels)"),
|
|
100, PIKA_MAX_IMAGE_SIZE, 1024,
|
|
G_PARAM_READWRITE);
|
|
|
|
PIKA_PROC_ARG_INT (procedure, "font-size",
|
|
_("_Font size"),
|
|
_("The font size to use in the page (in pt)"),
|
|
1, 1000, 12,
|
|
G_PARAM_READWRITE);
|
|
|
|
PIKA_PROC_VAL_IMAGE (procedure, "image",
|
|
"Image",
|
|
"The output image",
|
|
FALSE,
|
|
G_PARAM_READWRITE);
|
|
}
|
|
|
|
return procedure;
|
|
}
|
|
|
|
static PikaValueArray *
|
|
webpage_run (PikaProcedure *procedure,
|
|
PikaProcedureConfig *config,
|
|
gpointer run_data)
|
|
{
|
|
PikaValueArray *return_vals;
|
|
PikaRunMode run_mode;
|
|
PikaImage *image;
|
|
GError *error = NULL;
|
|
|
|
g_object_get (config, "run-mode", &run_mode, NULL);
|
|
|
|
if (run_mode == PIKA_RUN_INTERACTIVE &&
|
|
! webpage_dialog (procedure, config))
|
|
return pika_procedure_new_return_values (procedure,
|
|
PIKA_PDB_CANCEL,
|
|
NULL);
|
|
image = webpage_capture (config, &error);
|
|
|
|
if (! image)
|
|
return pika_procedure_new_return_values (procedure,
|
|
PIKA_PDB_EXECUTION_ERROR,
|
|
error);
|
|
|
|
if (run_mode == PIKA_RUN_INTERACTIVE)
|
|
pika_display_new (image);
|
|
|
|
return_vals = pika_procedure_new_return_values (procedure,
|
|
PIKA_PDB_SUCCESS,
|
|
NULL);
|
|
|
|
PIKA_VALUES_SET_IMAGE (return_vals, 1, image);
|
|
|
|
return return_vals;
|
|
}
|
|
|
|
static gboolean
|
|
webpage_dialog (PikaProcedure *procedure,
|
|
PikaProcedureConfig *config)
|
|
{
|
|
GtkWidget *dialog;
|
|
GtkListStore *store;
|
|
gboolean run;
|
|
|
|
pika_ui_init (PLUG_IN_BINARY);
|
|
|
|
dialog = pika_procedure_dialog_new (procedure,
|
|
PIKA_PROCEDURE_CONFIG (config),
|
|
_("Create from webpage"));
|
|
pika_procedure_dialog_set_ok_label (PIKA_PROCEDURE_DIALOG (dialog),
|
|
_("Cre_ate"));
|
|
store = pika_int_store_new (_("Huge"), 16,
|
|
_("Large"), 14,
|
|
C_("web-page", "Default"), 12,
|
|
_("Small"), 10,
|
|
_("Tiny"), 8,
|
|
NULL);
|
|
pika_procedure_dialog_get_int_combo (PIKA_PROCEDURE_DIALOG (dialog),
|
|
"font-size", PIKA_INT_STORE (store));
|
|
pika_procedure_dialog_fill (PIKA_PROCEDURE_DIALOG (dialog),
|
|
"url", "width", "font-size", NULL);
|
|
run = pika_procedure_dialog_run (PIKA_PROCEDURE_DIALOG (dialog));
|
|
gtk_widget_destroy (dialog);
|
|
|
|
return run;
|
|
}
|
|
|
|
static void
|
|
notify_progress_cb (WebKitWebView *view,
|
|
GParamSpec *pspec,
|
|
gpointer user_data)
|
|
{
|
|
static gdouble old_progress = 0.0;
|
|
gdouble progress;
|
|
|
|
progress = webkit_web_view_get_estimated_load_progress (view);
|
|
if ((progress - old_progress) > 0.01)
|
|
{
|
|
pika_progress_update (progress);
|
|
old_progress = progress;
|
|
}
|
|
}
|
|
|
|
static gboolean
|
|
load_failed_cb (WebKitWebView *view,
|
|
WebKitLoadEvent event,
|
|
gchar *uri,
|
|
gpointer web_error,
|
|
gpointer user_data)
|
|
{
|
|
GError **error = user_data;
|
|
|
|
*error = g_error_copy ((GError *) web_error);
|
|
|
|
gtk_main_quit ();
|
|
|
|
return TRUE;
|
|
}
|
|
|
|
static void
|
|
snapshot_ready (GObject *source_object,
|
|
GAsyncResult *result,
|
|
gpointer user_data)
|
|
{
|
|
WebpageResult *retval = user_data;
|
|
WebKitWebView *view = WEBKIT_WEB_VIEW (source_object);
|
|
cairo_surface_t *surface;
|
|
|
|
pika_progress_pulse ();
|
|
surface = webkit_web_view_get_snapshot_finish (view, result,
|
|
&retval->error);
|
|
pika_progress_pulse ();
|
|
|
|
if (surface)
|
|
{
|
|
gint width;
|
|
gint height;
|
|
PikaLayer *layer;
|
|
|
|
width = cairo_image_surface_get_width (surface);
|
|
height = cairo_image_surface_get_height (surface);
|
|
|
|
retval->image = pika_image_new (width, height, PIKA_RGB);
|
|
|
|
pika_image_undo_disable (retval->image);
|
|
layer = pika_layer_new_from_surface (retval->image, _("Webpage"),
|
|
surface,
|
|
0.25, 1.0);
|
|
pika_image_insert_layer (retval->image, layer, NULL, 0);
|
|
pika_image_undo_enable (retval->image);
|
|
|
|
cairo_surface_destroy (surface);
|
|
}
|
|
|
|
gtk_main_quit ();
|
|
}
|
|
|
|
static void
|
|
load_changed_cb (WebKitWebView *view,
|
|
WebKitLoadEvent event,
|
|
gpointer user_data)
|
|
{
|
|
if (event == WEBKIT_LOAD_FINISHED)
|
|
gtk_main_quit ();
|
|
}
|
|
|
|
static PikaImage *
|
|
webpage_capture (PikaProcedureConfig *config,
|
|
GError **error)
|
|
{
|
|
gchar *scheme;
|
|
GtkWidget *window;
|
|
GtkWidget *view;
|
|
WebKitSettings *settings;
|
|
char *ua;
|
|
|
|
gchar *url;
|
|
gint width;
|
|
gint font_size;
|
|
WebpageResult result;
|
|
|
|
g_object_get (config,
|
|
"url", &url,
|
|
"width", &width,
|
|
"font-size", &font_size,
|
|
NULL);
|
|
if (! url || strlen (url) == 0)
|
|
{
|
|
g_set_error (error, 0, 0, _("No URL was specified"));
|
|
return NULL;
|
|
}
|
|
|
|
scheme = g_uri_parse_scheme (url);
|
|
if (! scheme)
|
|
{
|
|
gchar *scheme_url;
|
|
|
|
/* If we were not given a well-formed URL, make one. */
|
|
scheme_url = g_strconcat ("https://", url, NULL);
|
|
g_free (url);
|
|
url = scheme_url;
|
|
}
|
|
g_free (scheme);
|
|
|
|
if (width < 32)
|
|
{
|
|
g_warning ("Width '%d' is too small. Clamped to 32.", width);
|
|
width = 32;
|
|
}
|
|
else if (width > 8192)
|
|
{
|
|
g_warning ("Width '%d' is too large. Clamped to 8192.", width);
|
|
width = 8192;
|
|
}
|
|
|
|
window = gtk_offscreen_window_new ();
|
|
gtk_widget_show (window);
|
|
|
|
view = webkit_web_view_new ();
|
|
gtk_widget_show (view);
|
|
|
|
gtk_widget_set_vexpand (view, TRUE);
|
|
gtk_widget_set_size_request (view, width, -1);
|
|
gtk_container_add (GTK_CONTAINER (window), view);
|
|
|
|
/* Append "PIKA/<PIKA_VERSION>" to the user agent string */
|
|
settings = webkit_web_view_get_settings (WEBKIT_WEB_VIEW (view));
|
|
ua = g_strdup_printf ("%s PIKA/%s",
|
|
webkit_settings_get_user_agent (settings),
|
|
PIKA_VERSION);
|
|
webkit_settings_set_user_agent (settings, ua);
|
|
g_free (ua);
|
|
|
|
/* Set font size */
|
|
webkit_settings_set_default_font_size (settings, font_size);
|
|
|
|
g_signal_connect (view, "notify::estimated-load-progress",
|
|
G_CALLBACK (notify_progress_cb),
|
|
window);
|
|
g_signal_connect (view, "load-failed",
|
|
G_CALLBACK (load_failed_cb),
|
|
error);
|
|
g_signal_connect (view, "load-changed",
|
|
G_CALLBACK (load_changed_cb),
|
|
window);
|
|
|
|
pika_progress_init_printf (_("Downloading webpage '%s'"), url);
|
|
|
|
webkit_web_view_load_uri (WEBKIT_WEB_VIEW (view), url);
|
|
gtk_main ();
|
|
|
|
result.error = NULL;
|
|
result.image = NULL;
|
|
if (*error == NULL)
|
|
{
|
|
pika_progress_init_printf (_("Transferring webpage image for '%s'"), url);
|
|
pika_progress_pulse ();
|
|
webkit_web_view_get_snapshot (WEBKIT_WEB_VIEW (view),
|
|
WEBKIT_SNAPSHOT_REGION_FULL_DOCUMENT,
|
|
WEBKIT_SNAPSHOT_OPTIONS_NONE,
|
|
NULL,
|
|
snapshot_ready,
|
|
&result);
|
|
|
|
gtk_main ();
|
|
|
|
if (result.error != NULL)
|
|
g_propagate_error (error, result.error);
|
|
}
|
|
|
|
gtk_widget_destroy (window);
|
|
|
|
pika_progress_update (1.0);
|
|
|
|
return result.image;
|
|
}
|