libbeagle/beagle/beagle-snippet-request.c

   1 /*
   2  * beagle-snippet-request.c
   3  *
   4  * Copyright (C) 2005 Novell, Inc.
   5  *
   6  */
   7
   8 /*
   9  * Permission is hereby granted, free of charge, to any person obtaining a
  10  * copy of this software and associated documentation files (the "Software"),
  11  * to deal in the Software without restriction, including without limitation
  12  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  13  * and/or sell copies of the Software, and to permit persons to whom the
  14  * Software is furnished to do so, subject to the following conditions:
  15  *
  16  * The above copyright notice and this permission notice shall be included in
  17  * all copies or substantial portions of the Software.
  18  *
  19  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  20  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  21  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  22  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  23  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  24  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  25  * DEALINGS IN THE SOFTWARE.
  26  */
  27
  28 #include <stdlib.h>
  29 #include <sys/types.h>
  30 #include <sys/socket.h>
  31 #include <sys/un.h>
  32
  33 #include "beagle-private.h"
  34 #include "beagle-snippet-request.h"
  35 #include "beagle-snippet-response.h"
  36
  37 typedef struct {
  38         BeagleQuery *query;
  39         BeagleHit *hit;
  40 } BeagleSnippetRequestPrivate;
  41
  42 #define BEAGLE_SNIPPET_REQUEST_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), BEAGLE_TYPE_SNIPPET_REQUEST, BeagleSnippetRequestPrivate))
  43
  44 static GObjectClass *parent_class = NULL;
  45
  46 static GString *
  47 beagle_snippet_request_to_xml (BeagleRequest *request, GError **err)
  48 {
  49         BeagleSnippetRequestPrivate *priv = BEAGLE_SNIPPET_REQUEST_GET_PRIVATE (request);
  50         GString *data;
  51         GSList *list;
  52
  53         g_return_val_if_fail (priv->query != NULL, NULL);
  54         g_return_val_if_fail (priv->hit != NULL, NULL);
  55
  56         data = g_string_new (NULL);
  57
  58         _beagle_request_append_standard_header (data, "SnippetRequest");
  59
  60         _beagle_hit_to_xml (priv->hit, data);
  61
  62         g_string_append (data, "<QueryTerms>");
  63         for (list = beagle_query_get_stemmed_text (priv->query); list != NULL; list = list->next) {
  64                 char *term = list->data;
  65
  66                 g_string_append_printf (data, "<string>%s</string>", term);
  67         }
  68         g_string_append (data, "</QueryTerms>");
  69
  70         _beagle_request_append_standard_footer (data);
  71
  72         return data;
  73 }
  74
  75 G_DEFINE_TYPE (BeagleSnippetRequest, beagle_snippet_request, BEAGLE_TYPE_REQUEST)
  76
  77 static void
  78 beagle_snippet_request_finalize (GObject *obj)
  79 {
  80         BeagleSnippetRequestPrivate *priv = BEAGLE_SNIPPET_REQUEST_GET_PRIVATE (obj);
  81
  82         if (priv->hit)
  83                 beagle_hit_unref (priv->hit);
  84
  85         if (priv->query != NULL)
  86                 g_object_unref (priv->query);
  87
  88         if (G_OBJECT_CLASS (parent_class)->finalize)
  89                 G_OBJECT_CLASS (parent_class)->finalize (obj);
  90 }
  91
  92 static void
  93 beagle_snippet_request_class_init (BeagleSnippetRequestClass *klass)
  94 {
  95         GObjectClass *obj_class = G_OBJECT_CLASS (klass);
  96         BeagleRequestClass *request_class = BEAGLE_REQUEST_CLASS (klass);
  97
  98         parent_class = g_type_class_peek_parent (klass);
  99
 100         obj_class->finalize = beagle_snippet_request_finalize;
 101         request_class->to_xml = beagle_snippet_request_to_xml;
 102
 103         g_type_class_add_private (klass, sizeof (BeagleSnippetRequestPrivate));
 104
 105         _beagle_request_class_set_response_types (request_class,
 106                                                   "SnippetResponse",
 107                                                   BEAGLE_TYPE_SNIPPET_RESPONSE,
 108                                                   NULL);
 109 }
 110
 111 static void
 112 beagle_snippet_request_init (BeagleSnippetRequest *snippet_request)
 113 {
 114 }
 115
 116 /**
 117  * beagle_snippet_request_new:
 118  *
 119  * Creates a new #BeagleSnippetRequest.
 120  *
 121  * Return value: the newly created #BeagleSnippetRequest.
 122  **/
 123 BeagleSnippetRequest *
 124 beagle_snippet_request_new (void)
 125 {
 126         BeagleSnippetRequest *snippet_request = g_object_new (BEAGLE_TYPE_SNIPPET_REQUEST, 0);
 127
 128         return snippet_request;
 129 }
 130
 131 /**
 132  * beagle_snippet_request_set_hit:
 133  * @request: a #BeagleSnippetRequest
 134  * @hit: a #BeagleHit
 135  *
 136  * Sets the @hit on the given #BeagleSnippetRequest.
 137  **/
 138 void
 139 beagle_snippet_request_set_hit (BeagleSnippetRequest *request,
 140                                 BeagleHit *hit)
 141 {
 142         BeagleSnippetRequestPrivate *priv;
 143
 144         g_return_if_fail (BEAGLE_IS_SNIPPET_REQUEST (request));
 145         g_return_if_fail (hit != NULL);
 146
 147         priv = BEAGLE_SNIPPET_REQUEST_GET_PRIVATE (request);
 148
 149         beagle_hit_ref (hit);
 150
 151         if (priv->hit)
 152                 beagle_hit_unref (priv->hit);
 153
 154         priv->hit = hit;
 155 }
 156
 157 /**
 158  * beagle_snippet_request_set:
 159  * @request: a #BeagleSnippetRequest
 160  * @query: a #BeagleQuery
 161  *
 162  * Set the query of the given #BeagleSnippetRequest from which to pull query terms.
 163  **/
 164 void
 165 beagle_snippet_request_set_query (BeagleSnippetRequest *request,
 166                                   BeagleQuery          *query)
 167 {
 168         BeagleSnippetRequestPrivate *priv;
 169
 170         g_return_if_fail (BEAGLE_IS_SNIPPET_REQUEST (request));
 171         g_return_if_fail (query != NULL);
 172
 173         priv = BEAGLE_SNIPPET_REQUEST_GET_PRIVATE (request);
 174
 175         g_object_ref (query);
 176
 177         if (priv->query != NULL)
 178                 g_object_unref (query);
 179
 180         priv->query = query;
 181 }
 182