![]() | ![]() | ![]() | gURLChecker Reference Manual | ![]() |
---|
#define UC_SYSTEM_NAME #define UC_VERSION #define UC_UPDATE_UI #define UC_ELEMENTS (x) #define UC_GLADE_XML_FILENAME #define UC_PIXMAPS_DIR #define UC_DIALOG_SETTINGS_DOCUMENT_TYPES_MAX_COLS #define UC_CHECK_BUTTON_MAX_DISPLAY #define UC_CHECK_MESSAGE_LABEL_FIRST #define UC_CHECK_MESSAGE_LABEL_SECOND #define UC_CHECK_MESSAGE_LABEL_THIRD #define UC_CHECK_DISPLAY_GOODLINKS #define UC_CHECK_DISPLAY_BADLINKS #define UC_CHECK_DISPLAY_TIMEOUTS #define UC_CHECK_DISPLAY_MALFORMEDLINKS #define UC_STATUS_CODE_INTERNALS_LIMIT #define UC_STATUS_CODE_PAGE_OK #define UC_STATUS_CODE_NO_DATA #define UC_STATUS_CODE_MOVED_PERMANENTLY #define UC_STATUS_CODE_REDIRECTED #define UC_STATUS_CODE_RESTRICTED #define UC_STATUS_CODE_PAGE_NOT_FOUND #define UC_STATUS_CODE_TIMEOUT #define UC_STATUS_CODE_FTP_MAX_CLIENTS #define UC_STATUS_CODE_UNKNOWN #define UC_STATUS_CODE_IGNORED_LINK #define UC_STATUS_CODE_MALFORMED_LINK #define UC_STATUS_CODE_FILE_PROTO_ERROR #define UC_STATUS_CODE_BAD_EMAIL_LINK #define UC_STATUS_CODE_BAD_EMAIL_LINK_MX #define UC_STATUS_CODE_GOOD_EMAIL_LINK #define UC_STATUS_CODE_FTP_OK #define UC_STATUS_CODE_FTP_BAD #define UC_IGNORED_LINK_BGCOLOR #define UC_BAD_LINK_BGCOLOR #define UC_GOOD_LINK_BGCOLOR #define UC_TIMEOUT_LINK_BGCOLOR #define UC_MALFORMED_LINK_BGCOLOR #define UC_HOST_UNREACHABLE_LINK_BGCOLOR #define UC_NO_DATA_LINK_BGCOLOR #define UC_RESTRICTED_LINK_BGCOLOR #define UC_FILE_ERROR_LINK_BGCOLOR #define UC_BAD_EMAIL_LINK_BGCOLOR #define UC_GOOD_EMAIL_LINK_BGCOLOR #define UC_CHECK_PROTOCOLS_ACCEPTED #define UC_CHECK_PROTOCOLS_ACCEPTED_LEN #define UC_CHECK_PROTOCOLS_GET_ACCEPTED #define UC_SPLIT_DELIMITER #define UC_DEFAULT_DOCUMENTS #define UC_DEFAULT_DOCUMENTS_LEN #define UC_DEFAULT_IMAGES #define UC_DEFAULT_IMAGES_LEN #define UC_LABEL_DISPLAY_MAX_LEN #define UC_GET_DEFAULT_DOCUMENTS #define UC_GET_DEFAULT_IMAGES #define UC_DEFAULT_WEB_BROWSER_PATH #define WSENS (glade_pointer, name, value) #define UC_GET_WIDGET (name, window, widget) #define UC_SET_WIDGET (name, window, widget) #define WINIT (name, glade, widget) #define WGET (name, glade, widget) #define UC_LABEL_DISPLAY_IN_TABLE (table, label, name, p1, p2, p3, p4) #define UC_BUFFER_LEN #define UC_BUFFER_DATE_LEN #define UC_HEADER_STATUS_CODE_LEN #define UC_HEADER_STATUS_CODE_FIRST_POS #define UC_PROTOCOL_FTP #define UC_PROTOCOL_HTTP #define UC_PROTOCOL_HTTPS #define UC_PROTOCOL_MAILTO #define UC_PROTOCOL_FILE #define UC_CONTENT_TYPE #define UC_CONTENT_TYPE_FTP #define UC_CONTENT_LENGTH #define UC_LAST_MODIFIED #define UC_CONTENT_TYPE_HTML #define UC_CONTENT_TYPE_CSS #define UC_HEADER_STATUS #define UC_CONTENT_LOCATION #define UC_LOCATION #define UC_SERVER #define UC_URL_DEFAULT_PORT #define UC_URL_DEFAULT_SSL_PORT #define UC_URL_DEFAULT_FTP_PORT #define UC_SOCKET_OPEN_FORCE_ARGS_USE #define UC_SOCKET_OPEN_DEFAULT #define UC_SECURE_BYTES_ADDING #define UC_CHECK_MINIMUM_SPACE_REQUIRED #define UC_TOOLTIPS_DELAY_DEFAULT #define UC_CHECK_WAIT_DEFAULT #define UC_CHECK_TIMEOUT_DEFAULT #define UC_MAX_DEPTH_LEVEL #define UC_TIMEOUTS_BLOCKED_DEFAULT #define UC_USER_AGENT struct UCStatusCode; struct UCHTMLTag; struct UCLinkProperties; struct GHashNode; struct GHashTable;
#define UC_DIALOG_SETTINGS_DOCUMENT_TYPES_MAX_COLS
Macro for the maximum number of columns to display for document types in the "Documents" and "Images" notbooks of the settings.
#define UC_CHECK_BUTTON_MAX_DISPLAY
Macro for the maximum number of check boxes to display for document types in the "Documents" and "Images" notbooks of the settings.
#define UC_CHECK_MESSAGE_LABEL_FIRST
Macro to indicate on which location on the check dialog we must dislay a message.
#define UC_CHECK_MESSAGE_LABEL_SECOND
Macro to indicate on which location on the check dialog we must dislay a message.
#define UC_CHECK_MESSAGE_LABEL_THIRD
Macro to indicate on which location on the check dialog we must dislay a message.
#define UC_CHECK_DISPLAY_GOODLINKS
Macro to indicate that we must display only good links.
#define UC_CHECK_DISPLAY_BADLINKS
Macro to indicate that we must display only bad links.
#define UC_CHECK_DISPLAY_TIMEOUTS
Macro to indicate that we must display only timeouts links.
#define UC_CHECK_DISPLAY_MALFORMEDLINKS
Macro to indicate that we must display only malformed links.
#define UC_STATUS_CODE_INTERNALS_LIMIT
Macro to indicate that all status codes upper are gURLChecker internal status codes.
#define UC_STATUS_CODE_MOVED_PERMANENTLY
Macro for HTTP status code 301.
#define UC_STATUS_CODE_FTP_MAX_CLIENTS
Macro for FTP response we are using for "Max clients".
#define UC_STATUS_CODE_IGNORED_LINK
Macro for gURLChecker internal status code.
#define UC_STATUS_CODE_MALFORMED_LINK
Macro for gURLChecker internal status code.
#define UC_STATUS_CODE_FILE_PROTO_ERROR
Macro for gURLChecker internal status code.
#define UC_STATUS_CODE_BAD_EMAIL_LINK
Macro for gURLChecker internal status code.
#define UC_STATUS_CODE_BAD_EMAIL_LINK_MX
Macro for gURLChecker internal status code.
#define UC_STATUS_CODE_GOOD_EMAIL_LINK
Macro for gURLChecker internal status code.
#define UC_HOST_UNREACHABLE_LINK_BGCOLOR
Macro for "host unreachable" links color.
#define UC_NO_DATA_LINK_BGCOLOR
Macro for color of good links with no content.
#define UC_FILE_ERROR_LINK_BGCOLOR
Macro for local files links color when user choose to consider them like an error.
#define UC_CHECK_PROTOCOLS_ACCEPTED
Macro for indicate which protocols we can check. For the moment gURLChecker can only check HTTP protocol.
#define UC_CHECK_PROTOCOLS_ACCEPTED_LEN
Macro for indicate the number of protocols we can check.
#define UC_CHECK_PROTOCOLS_GET_ACCEPTED
Macro to get protocols we can check.
#define UC_DEFAULT_DOCUMENTS
Macro to indicate which documents extensions we want to manage.
#define UC_DEFAULT_DOCUMENTS_LEN
Macro to indicate the number of documents extensions we want to manage.
#define UC_DEFAULT_IMAGES
Macro to indicate which images extensions we want to manage.
#define UC_DEFAULT_IMAGES_LEN
Macro to indicate the number of images extensions we want to manage.
#define UC_LABEL_DISPLAY_MAX_LEN
Macro to indicate the maximum display size of a string.
#define UC_GET_DEFAULT_DOCUMENTS
Macro to get documents extensions we can manage.
#define UC_DEFAULT_WEB_BROWSER_PATH
Macro to specify default browser path location.
#define WSENS(glade_pointer, name, value)
Macro to set the "sensitive" property of a widget.
glade_pointer : | GladeXML object to work with. |
name : | name of the widget in libglade XML file. |
value : | TRUE or FALSE. |
#define UC_GET_WIDGET(name, window, widget)
Macro to get a GtkWidget in the third argument.
see: UC_SET_WIDGET()
name : | name of the widget. |
window : | GtkWindow widget to work with. |
widget : | GtkWidget to work with. |
#define UC_SET_WIDGET(name, window, widget)
Macro to save a GtkWidget to retrive it faster later.
see: UC_GET_WIDGET()
name : | name of the widget. |
window : | GtkWindow widget to work with. |
widget : | GtkWidget to work with. |
#define WINIT(name, glade, widget)
Macro to initialize a GladeXML object before working with it.
see: WGET()
name : | name of the main glade object. |
glade : | a GladeXML variable to initialize. |
widget : | the corresponding GtkWidget to initialize. |
#define WGET(name, glade, widget)
Macro to get a GtkWidget from a GladeXML object.
see: WINIT()
name : | name of the widget to retreive. |
glade : | GladeXML object to work with. |
widget : | GtkWidget to initialize. |
#define UC_LABEL_DISPLAY_IN_TABLE(table, label, name, p1, p2, p3, p4)
table : | |
label : | |
name : | |
p1 : | |
p2 : | |
p3 : | |
p4 : |
|
#define UC_HEADER_STATUS_CODE_LEN
Macro indicate the maximum length of a HTTP status code.
#define UC_HEADER_STATUS_CODE_FIRST_POS
Macro to indicate the first position of the HTTP status code in the buffer.
#define UC_URL_DEFAULT_PORT
Macro to indicate the default URL port when it is not specified.
#define UC_URL_DEFAULT_SSL_PORT
Macro to indicate the default URL port when it is not specified.
#define UC_SECURE_BYTES_ADDING
Macro to indicate security adding for free partition space verification for the working directory.
#define UC_CHECK_MINIMUM_SPACE_REQUIRED
Macro to indicate the minimum free space we must leave on the disk.
#define UC_TOOLTIPS_DELAY_DEFAULT
Macro to indicate main tree view tooltip delay.
#define UC_CHECK_WAIT_DEFAULT
Macro for default time to wait between links check.
#define UC_TIMEOUTS_BLOCKED_DEFAULT
Macro for maximum number of attempts after a timedouted host should not be checked anymore
struct UCStatusCode { gchar *color; gchar *message; gchar *description; GdkPixbuf *icon_file; };
Structure to store status code properties.
gchar *color | Color to associate with the status code. |
gchar *message | Short message to display. |
gchar *description | Description of the meaning of the status code. |
GdkPixbuf *icon_file | Image to assiciate with the status code. |
struct UCHTMLTag { guint depth; gchar *label; gchar *value; UCLinkType type; };
Structure for HTML tags nodes.
guint depth | Depth of this node. |
gchar *label | Label of the link. |
gchar *value | Value of the link. |
UCLinkType type | Type of the link. |
struct UCLinkProperties { guint32 uid; gchar *treeview_path; struct _UCLinkProperties *parent; gchar *current_path; GtkTreeIter iter; gpointer tag; UCLinkType link_type; GdkPixbuf *link_icon; GdkPixbuf *status_icon; gchar *link_value; gchar *url; gchar *normalized_url; gchar *label; gchar *protocol; gchar *h_name; gchar *port; gchar *path; gchar *args; gchar *domain; GHashTable *header; guint header_size; guint depth_level; gboolean is_parsable; gboolean is_downloadable; gboolean checked; xmlNodePtr xml_node; gboolean to_delete; GList *metas; GList *emails; GList *all_links; GList *childs; GList *similar_links_parents; GList *tags; };
Structure to store links properties.
guint32 uid | Unique identifier for this node. |
gchar *treeview_path | tree view path of this node (it is filled on tree view display). |
struct _UCLinkProperties *parent | Parent of this node. |
gchar *current_path | Current path of the page containing this link. |
GtkTreeIter iter | GtkTreeIter iterator used for main URL treeview management. |
gpointer tag | UCHTMLTag node for this link. |
UCLinkType link_type | Type of this link. |
GdkPixbuf *link_icon | Icon associated with the type of this link. |
GdkPixbuf *status_icon | Icon associated with the status of this link. |
gchar *link_value | Brut value of this link. |
gchar *url | Well formed URL of this link. |
gchar *normalized_url | Absolute URL. |
gchar *label | Label of this link. |
gchar *protocol | Protocol of the URL. |
gchar *h_name | Hostname of the URL. |
gchar *port | Port of the URL. |
gchar *path | Path of the URL. |
gchar *args | Arguments of the URL. |
gchar *domain | Domain name of the URL hostname. |
GHashTable *header | GHashTable containing HTTP header fields and values. |
guint header_size | Size of the HTTP header. |
guint depth_level | Depth level of this node. |
gboolean is_parsable | TRUE if the content pointed by this link can be parse to retreive others links. |
gboolean is_downloadable | TRUE if the content of this link can be downloaded. |
gboolean checked | TRUE is this link have already been proccessed. |
xmlNodePtr xml_node | Reference on the XmlNodePtr of the XmlDocPtr for this node. This field is used only for bookmarks. |
gboolean to_delete | TRUE if this node have been deleted. This field is used only for bookmarks. |
GList *metas | GList of page HTML meta tags (pointers on this node "tags" propertie). |
GList *emails | GList of emails in this page (pointers on this node "tags" propertie). |
GList *all_links | GList of all links in this page (pointers on this node "tags" propertie). |
GList *childs | Childs nodes of this node. |
GList *similar_links_parents | Pointer on other nodes for links in this page that have been already processed in another page. |
GList *tags | GList of UCHTMLTag for all links in this page. |
struct GHashNode { gpointer key; gpointer value; GHashNode *next; };
Taken from glibc ghash.c to avoid use of g_hash_table_foreach function.
gpointer key | Key. |
gpointer value | Value. |
GHashNode *next | Next GHashNode. |
<<< gURLChecker API description | application >>> |