beagled/WebServices/WebServiceFrontEnd.cs

   1 //
   2 // WebServiceFrontEnd.cs
   3 //
   4 // Copyright (C) 2005 Novell, Inc.
   5 //
   6 // Authors:
   7 //   Vijay K. Nanjundaswamy (knvijay@novell.com)
   8 //
   9
  10 // Permission is hereby granted, free of charge, to any person obtaining a
  11 // copy of this software and associated documentation files (the "Software"),
  12 // to deal in the Software without restriction, including without limitation
  13 // the rights to use, copy, modify, merge, publish, distribute, sublicense,
  14 // and/or sell copies of the Software, and to permit persons to whom the
  15 // Software is furnished to do so, subject to the following conditions:
  16 //
  17 // The above copyright notice and this permission notice shall be included in
  18 // all copies or substantial portions of the Software.
  19 //
  20 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  21 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  22 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  23 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  24 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  25 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  26 // DEALINGS IN THE SOFTWARE.
  27 //
  28
  29 using System;
  30 using System.Threading;
  31 using System.Collections;
  32
  33 using System.Web;
  34 using System.Web.Services;
  35 using System.Web.Services.Protocols;
  36
  37 using System.Runtime.Remoting;
  38 using System.Runtime.Remoting.Channels;
  39 using System.Runtime.Remoting.Channels.Tcp;
  40
  41 using Beagle.Daemon;
  42 using Beagle.WebService;
  43
  44
  45 namespace WebService_CodeBehind {
  46
  47         struct remoteChannel {
  48                 //.Net Remoting channel to beagledWeb, WebServiceBackEnd within beagled
  49                 private static bool registerChannelDone = false;
  50
  51                 public static void Register() {
  52
  53                         if (registerChannelDone)
  54                                 return;
  55
  56                         ChannelServices.RegisterChannel(new TcpChannel());
  57
  58                         WellKnownClientTypeEntry WKCTE_Web =
  59                         new WellKnownClientTypeEntry(typeof(WebBackEnd),
  60                                 "tcp://localhost:8347/WebBackEnd.rem");
  61                         RemotingConfiguration.RegisterWellKnownClientType(WKCTE_Web);
  62
  63                         WellKnownClientTypeEntry WKCTE_WebService =
  64                         new WellKnownClientTypeEntry(typeof(WebServiceBackEnd),
  65                                 "tcp://localhost:8347/WebServiceBackEnd.rem");
  66                         RemotingConfiguration.RegisterWellKnownClientType(WKCTE_WebService);
  67
  68                         registerChannelDone = true;
  69                 }
  70         }
  71
  72     [WebService(Description = "Web Service Interface to Beagle",
  73      Namespace = "http://www.gnome.org/projects/beagle/webservices",
  74      Name = "BeagleWebService")]
  75     public class BeagleWebService: System.Web.Services.WebService {
  76
  77                 private WebServiceBackEnd remoteObj = null;
  78
  79                 private SearchResult initialQuery(SearchRequest req)
  80                 {
  81                         SearchResult sr;
  82
  83                         if (req.text == null || req.text.Length == 0 ||
  84                                 (req.text.Length == 1 && req.text[0].Trim()== "")) {
  85
  86                                 sr = new SearchResult();
  87                             sr.statusCode = WebServiceBackEnd.SC_INVALID_QUERY;
  88                             sr.statusMsg = "No search terms specified";
  89                             return sr;
  90                         }
  91
  92                         remoteChannel.Register();
  93
  94                         if (remoteObj == null)
  95                                 remoteObj = new WebServiceBackEnd();
  96
  97                         bool isLocalReq = HttpContext.Current.Request.Url.IsLoopback;
  98
  99                         if ((remoteObj == null) || !(remoteObj.allowGlobalAccess ||     isLocalReq) )   {
 100
 101                                 return restrictedAccessResult();
 102                         }
 103
 104                         sr = remoteObj.doQuery(req, isLocalReq);
 105                         return sr;
 106            }
 107
 108         [WebMethod(Description = "Full object interface to Beagle")]
 109         [System.Web.Services.Protocols.SoapDocumentMethodAttribute(
 110         "http://www.gnome.org/projects/beagle/webservices/BeagleQuery",
 111         RequestNamespace="http://www.gnome.org/projects/beagle/webservices",
 112         ResponseNamespace="http://www.gnome.org/projects/beagle/webservices")]
 113         public SearchResult BeagleQuery(SearchRequest req)
 114         {
 115                 return initialQuery(req);
 116         }
 117
 118         [WebMethod(Description = "Simple Interface to Beagle")]
 119         [System.Web.Services.Protocols.SoapDocumentMethodAttribute(
 120         "http://www.gnome.org/projects/beagle/webservices/SimpleQuery",
 121         RequestNamespace="http://www.gnome.org/projects/beagle/webservices",
 122         ResponseNamespace="http://www.gnome.org/projects/beagle/webservices")]
 123         public SearchResult SimpleQuery(string text)
 124         {
 125                 SearchResult sr;
 126
 127                 if (text == null || text.Trim() == "") {
 128
 129                         sr = new SearchResult();
 130                         sr.statusCode = WebServiceBackEnd.SC_INVALID_QUERY;
 131                         sr.statusMsg = "No search terms specified";
 132                         return sr;
 133                 }
 134
 135                 SearchRequest srq = new SearchRequest();
 136
 137                 srq.text = new string[1];
 138                 srq.text[0] = text.Trim();
 139
 140                 srq.qdomain = Beagle.QueryDomain.Neighborhood;
 141
 142                 return initialQuery(srq);
 143         }
 144
 145         [WebMethod(Description = "Full text Interface to Beagle")]
 146         [System.Web.Services.Protocols.SoapDocumentMethodAttribute(
 147         "http://www.gnome.org/projects/beagle/webservices/SimpleQuery2",
 148         RequestNamespace="http://www.gnome.org/projects/beagle/webservices",
 149         ResponseNamespace="http://www.gnome.org/projects/beagle/webservices")]
 150         public SearchResult SimpleQuery2(string text, string mimeType, string source, string queryDomain)
 151         {
 152                 SearchResult sr;
 153
 154                 if (text == null || text.Trim() == "") {
 155
 156                         sr = new SearchResult();
 157                         sr.statusCode = WebServiceBackEnd.SC_INVALID_QUERY;
 158                         sr.statusMsg = "No search terms specified";
 159                         return sr;
 160                 }
 161
 162                 SearchRequest srq = new SearchRequest();
 163
 164                 srq.text = new string[1];
 165                 srq.text[0] = text.Trim();
 166
 167                 if (mimeType != null && mimeType != "")  {
 168
 169                         srq.mimeType = new string[1];
 170                         srq.mimeType[0] = mimeType.Trim();
 171                 }
 172
 173                 srq.qdomain = Beagle.QueryDomain.Neighborhood;
 174                 switch (queryDomain.Trim().ToLower()) {
 175
 176                         case "local" :  srq.qdomain = Beagle.QueryDomain.Local;
 177                                                         break;
 178
 179                         case "system" : srq.qdomain = Beagle.QueryDomain.System;
 180                                                         break;
 181
 182                         case "neighborhood" :
 183                                                         srq.qdomain = Beagle.QueryDomain.Neighborhood;
 184                                                         break;
 185
 186                         case "global" : srq.qdomain = Beagle.QueryDomain.Global;
 187                                                         break;
 188
 189                         default:                srq.qdomain = Beagle.QueryDomain.Neighborhood;
 190                                                         break;
 191                 }
 192
 193                 string sourceSelector = null;
 194                 srq.searchSources = new string[1];
 195
 196                 switch (source.Trim().ToLower()) {
 197
 198                         case "files" :  sourceSelector = "Files";
 199                                                         break;
 200
 201                         case "addressbook" :
 202                                                         sourceSelector = "Contact";
 203                                                         break;
 204
 205                         case "mail" :   sourceSelector = "MailMessage";
 206                                                         break;
 207
 208                         case "web":     sourceSelector = "WebHistory";
 209                                                         break;
 210
 211                         case "chats":   sourceSelector = "IMLog";
 212                                                         break;
 213
 214                         default:                sourceSelector = null;
 215                                                         break;
 216                 }
 217
 218                 srq.searchSources[0] = sourceSelector;
 219                 return initialQuery(srq);
 220         }
 221
 222         [WebMethod(Description = "Common Interface to get more results from Beagle")]
 223         [System.Web.Services.Protocols.SoapDocumentMethodAttribute(
 224         "http://www.gnome.org/projects/beagle/webservices/GetMoreResults",
 225         RequestNamespace="http://www.gnome.org/projects/beagle/webservices",
 226         ResponseNamespace="http://www.gnome.org/projects/beagle/webservices")]
 227         public SearchResult GetResults(GetResultsRequest req)
 228         {
 229                         SearchResult sr;
 230
 231                         if (req.searchToken == null | req.searchToken == "")  {
 232                                 sr = new SearchResult();
 233                                 sr.statusCode = WebServiceBackEnd.SC_INVALID_SEARCH_TOKEN;
 234                                 sr.statusMsg = "Invalid Search Token";
 235                         }
 236
 237                         remoteChannel.Register();
 238
 239                         if (remoteObj == null)
 240                                 remoteObj = new WebServiceBackEnd();
 241
 242                         bool isLocalReq = HttpContext.Current.Request.Url.IsLoopback;
 243
 244                         if ((remoteObj == null) || !(remoteObj.allowGlobalAccess ||     isLocalReq) )   {
 245
 246                                 return restrictedAccessResult();
 247                         }
 248
 249                         sr = remoteObj.getResults(req, isLocalReq);
 250                         return sr;
 251         }
 252
 253         [WebMethod(Description = "Common Interface to get Snippets for results")]
 254         [System.Web.Services.Protocols.SoapDocumentMethodAttribute(
 255         "http://www.gnome.org/projects/beagle/webservices/GetSnippets",
 256         RequestNamespace="http://www.gnome.org/projects/beagle/webservices",
 257         ResponseNamespace="http://www.gnome.org/projects/beagle/webservices")]
 258         public HitSnippet[] GetSnippets(GetSnippetsRequest req)
 259         {
 260                 HitSnippet[] response;
 261
 262                 if (req.searchToken == null | req.searchToken == "")  {
 263                         response = new HitSnippet[0];
 264                         return response;
 265                 }
 266
 267                 remoteChannel.Register();
 268
 269                 if (remoteObj == null)
 270                         remoteObj = new WebServiceBackEnd();
 271
 272                 bool isLocalReq = HttpContext.Current.Request.Url.IsLoopback;
 273
 274                 if ((remoteObj == null) || !(remoteObj.allowGlobalAccess ||     isLocalReq) )   {
 275
 276                         response = new HitSnippet[0];
 277                         return response;
 278                 }
 279
 280                 if (req.hitHashCodes.Length < 1)
 281                         response = new HitSnippet[0];
 282                 else
 283                         response = remoteObj.getSnippets(req);
 284
 285                 return response;
 286         }
 287
 288         private static string localReqOnlyMsg = "Beagle web service unavailable or access restricted to local address only !";
 289
 290         private SearchResult restrictedAccessResult()
 291         {
 292                 SearchResult sr = new SearchResult();
 293
 294                 sr.totalResults = 0;
 295
 296                 sr.statusCode = WebServiceBackEnd.SC_UNAUTHORIZED_ACCESS;
 297                 sr.statusMsg = localReqOnlyMsg;
 298
 299                 return sr;
 300         }
 301   }
 302 }