1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193
|
/*
** SWISH++
** xml_formatter.c
**
** Copyright (C) 2001 Paul J. Lucas
**
** 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 2 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, write to the Free Software
** Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
// standard
#include <cstring> /* for strpbrk(3) */
#include <string>
// local
#include "file_info.h"
#include "index_segment.h"
#include "platform.h"
#include "util.h"
#include "xml_formatter.h"
using namespace std;
#define SWISH_PATH "/pauljlucas/software/swish"
#define SWISH_NS_URI "http://www.pauljlucas.org" SWISH_PATH
#define SWISH_PHYS_URI "http://homepage.mac.com" SWISH_PATH
#define XSI_URI "http://www.w3.org/2001/XMLSchema-instance"
#define SEARCH_RESULTS "SearchResults"
#define SEARCH_RESULTS_DTD SEARCH_RESULTS ".dtd"
#define SEARCH_RESULTS_NS_URI SWISH_NS_URI "/" SEARCH_RESULTS
#define SEARCH_RESULTS_PHYS_URI SWISH_PHYS_URI "/" SEARCH_RESULTS
#define SEARCH_RESULTS_XSD SEARCH_RESULTS ".xsd"
extern index_segment directories;
//*****************************************************************************
//
// SYNOPSIS
//
static string escape( char const *s )
//
// DESCRIPTION
//
// Escape all '&' and '<' characters in a given string by replacing them
// with "&" or "<", respectively.
//
// PARAMETERS
//
// s The string to be escaped.
//
// RETURN VALUE
//
// Returns a new string.
//
// SEE ALSO
//
// Tim Bray, et al. "Character Data and Markup," Extensible Markup
// Language (XML) 1.0, section 2.4, February 10, 1998.
//
//*****************************************************************************
{
string result = s;
register string::size_type i;
for ( i = 0; (i = result.find( '&', i )) != string::npos; i += 5 )
result.replace( i, 1, "&" );
for ( i = 0; (i = result.find( '<', i )) != string::npos; i += 4 )
result.replace( i, 1, "<" );
return result;
}
//*****************************************************************************
//
// SYNOPSIS
//
xml_formatter::~xml_formatter()
//
// DESCRIPTION
//
// Destroy an xml_formatter.
//
// NOTE
//
// This is out-of-line only because it's virtual.
//
//*****************************************************************************
{
// do nothing
}
//*****************************************************************************
//
// SYNOPSIS
//
void xml_formatter::pre( stop_word_set const &stop_words ) const
//
// DESCRIPTION
//
// Output search-result "meta" information before the results themselves:
// the set of stop words found in the query (if any) and the number of
// results.
//
// PARAMETERS
//
// stop_words The set of stop words.
//
//*****************************************************************************
{
out_ << "<?xml version=\"1.0\" encoding=\"us-ascii\"?>\n"
"<!DOCTYPE SearchResults SYSTEM\n"
" \"" SWISH_PHYS_URI "/" SEARCH_RESULTS_DTD "\">\n"
"<SearchResults\n"
" xmlns=\"" SEARCH_RESULTS_NS_URI "\"\n"
" xmlns:xsi=\"" XSI_URI "\"\n"
" xsi:schemaLocation=\"" SEARCH_RESULTS_PHYS_URI
" " SEARCH_RESULTS_XSD "\">\n";
if ( !stop_words.empty() ) {
out_ << " <IgnoredList>\n";
FOR_EACH( stop_word_set, stop_words, word )
out_ << " <Ignored>" << *word << "</Ignored>\n";
out_ << " </IgnoredList>\n";
}
out_ << " <ResultCount>" << results_ << "</ResultCount>\n";
if ( results_ )
out_ << " <ResultList>\n";
}
//*****************************************************************************
//
// SYNOPSIS
//
void xml_formatter::result( int rank, file_info const &fi ) const
//
// DESCRIPTION
//
// Output an individual search result's information: it's rank, path,
// size, and title.
//
// PARAMETERS
//
// rank The rank (1-100) of the result.
//
// fi The search result's file information.
//
//*****************************************************************************
{
out_ << " <File>\n"
" <Rank>" << rank << "</Rank>\n"
" <Path>"
<< directories[ fi.dir_index() ] << '/' << fi.file_name()
<< "</Path>\n"
" <Size>" << fi.size() << "</Size>\n"
" <Title>";
if ( ::strpbrk( fi.title(), "&<" ) )
out_ << escape( fi.title() );
else
out_ << fi.title();
out_ << "</Title>\n"
" </File>\n";
}
//*****************************************************************************
//
// SYNOPSIS
//
void xml_formatter::post() const
//
// DESCRIPTION
//
// Output end tags of XML elements.
//
//*****************************************************************************
{
if ( results_ )
out_ << " </ResultList>\n";
out_ << "</SearchResults>\n";
}
/* vim:set noet sw=8 ts=8: */
|