update html docs
[spider.git] / html / adminmanual-7.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
2 <HTML>
3 <HEAD>
4  <META NAME="GENERATOR" CONTENT="SGML-Tools 1.0.9">
5  <TITLE>The DXSpider Installation and Administration Manual: Filtering (New Style v1.45 and later)</TITLE>
6  <LINK HREF="adminmanual-8.html" REL=next>
7  <LINK HREF="adminmanual-6.html" REL=previous>
8  <LINK HREF="adminmanual.html#toc7" REL=contents>
9 <link rel=stylesheet href="style.css" type="text/css" title="default stylesheet">
10 </HEAD>
11 <BODY>
12 <A HREF="adminmanual-8.html">Next</A>
13 <A HREF="adminmanual-6.html">Previous</A>
14 <A HREF="adminmanual.html#toc7">Contents</A>
15 <HR>
16 <H2><A NAME="s7">7. Filtering (New Style v1.45 and later)</A></H2>
17
18 <H2><A NAME="ss7.1">7.1 General filter rules</A>
19 </H2>
20
21 <P>Upto v1.44 it was not possible for the user to set their own filters.  From 
22 v1.45 though that has all changed.  It is now possible to set filters for just 
23 about anything you wish.  If you have just updated from an older version of 
24 DXSpider you will need to update your new filters.  You do not need to do 
25 anything with your old filters, they will be renamed as you update.
26 <P>
27 <P>There are 3 basic commands involved in setting and manipulating filters.  These 
28 are <EM>accept</EM>, <EM>reject</EM> and <EM>clear</EM>.  First we will look
29 generally at filtering. There are a number of things you can filter in the 
30 DXSpider system. They all use the same general mechanism.
31 <P>
32 <P>In general terms you can create a 'reject' or an 'accept' filter which can have 
33 up to 10 lines in it. You do this using, for example ... 
34 <P>
35 <BLOCKQUOTE><CODE>
36 <PRE>
37  
38 accept/spots .....
39 reject/spots .....
40 </PRE>
41 </CODE></BLOCKQUOTE>
42 <P>where ..... are the specific commands for that type of filter. There are filters 
43 for spots, wwv, announce, wcy and (for sysops) connects. See each different 
44 accept or reject command reference for more details.
45 <P>There is also a command to clear out one or more lines in a filter. They are ...
46 <P>
47 <BLOCKQUOTE><CODE>
48 <PRE>
49 clear/spots 1
50 clear/spots all
51 </PRE>
52 </CODE></BLOCKQUOTE>
53 <P>There is clear/xxxx command for each type of filter.
54 <P>
55 <P>and you can check that your filters have worked by the command ... 
56 <P>
57 <BLOCKQUOTE><CODE>
58 <PRE>
59   
60 show/filter
61 </PRE>
62 </CODE></BLOCKQUOTE>
63 <P>
64 <P>For now we are going to use spots for the examples, but you can apply the same
65 principles to all types of filter.
66 <P>
67 <H2><A NAME="ss7.2">7.2 Types of filter</A>
68 </H2>
69
70 <P>There are two main types of filter, <EM>accept</EM> or <EM>reject</EM>.  You 
71 can use either to achieve the result you want dependent on your own preference 
72 and which is more simple to do.  It is pointless writing 8 lines of reject 
73 filters when 1 accept filter would do the same thing!  Each filter has 10 
74 lines (of any length) which are tried in order.  If a line matches then the 
75 action you have specified is taken (ie reject means ignore it and accept 
76 means take it)
77 <P>
78 <P>If you specify reject filters, then any lines that arrive that match the filter 
79 will be dumped but all else will be accepted.  If you use an accept filter, 
80 then ONLY the lines in the filter will be accepted and all else will be dumped.
81 For example if you have a single line <EM>accept</EM> filter ...
82 <P>
83 <BLOCKQUOTE><CODE>
84 <PRE>
85 accept/spots on vhf and (by_zone 14,15,16 or call_zone 14,15,16)
86 </PRE>
87 </CODE></BLOCKQUOTE>
88 <P>then you will <EM>ONLY</EM> get VHF spots <EM>from</EM> or <EM>to</EM> CQ zones 
89 14, 15 and 16.
90 <P>
91 <P>If you set a reject filter like this ...
92 <P>
93 <BLOCKQUOTE><CODE>
94 <PRE>
95 reject/spots on hf/cw
96 </PRE>
97 </CODE></BLOCKQUOTE>
98 <P>Then you will get everything <EM>EXCEPT</EM> HF CW spots.  You could make this 
99 single filter even more flexible.  For example, if you are interested in IOTA 
100 and will work it even on CW even though normally you are not interested in 
101 CW, then you could say ...
102 <P>
103 <BLOCKQUOTE><CODE>
104 <PRE>
105 reject/spots on hf/cw and not info iota
106 </PRE>
107 </CODE></BLOCKQUOTE>
108 <P>But in that case you might only be interested in iota and say:-
109 <P>
110 <BLOCKQUOTE><CODE>
111 <PRE>
112 accept/spots not on hf/cw or info iota
113 </PRE>
114 </CODE></BLOCKQUOTE>
115 <P>which achieves exactly the same thing. You should choose one or the other 
116 until you are comfortable with the way it works. You can mix them if you 
117 wish (actually you can have an accept AND a reject on the same line) but 
118 don't attempt this until you are sure you know what you are doing!
119 <P>
120 <P>You can arrange your filter lines into logical units, either for your own
121 understanding or simply convenience. Here is an example ...
122 <P>
123 <BLOCKQUOTE><CODE>
124 <PRE>
125 reject/spots 1 on hf/cw
126 reject/spots 2 on 50000/1400000 not (by_zone 14,15,16 or call_zone 14,15,16)  
127 </PRE>
128 </CODE></BLOCKQUOTE>
129 <P>What this does is to ignore all HF CW spots and also rejects any spots on VHF 
130 which don't either originate or spot someone in Europe. 
131 <P>
132 <P>This is an example where you would use a line number (1 and 2 in this case), if 
133 you leave the digit out, the system assumes '1'. Digits '0'-'9' are available.  
134 This make it easier to see just what filters you have set.  It also makes it 
135 more simple to remove individual filters, during a contest for example.
136 <P>
137 <P>You will notice in the above example that the second line has brackets.  Look 
138 at the line logically.  You can see there are 2 separate sections to it.  We 
139 are saying reject spots that are VHF or above <EM>APART</EM> from those in 
140 zones 14, 15 and 16 (either spotted there or originated there).  If you did 
141 not have the brackets to separate the 2 sections, then Spider would read it 
142 logically from the front and see a different expression entirely ...
143 <P>
144 <BLOCKQUOTE><CODE>
145 <PRE>
146 (on 50000/1400000 and by_zone 14,15,16) or call_zone 14,15,16 
147 </PRE>
148 </CODE></BLOCKQUOTE>
149 <P>The simple way to remember this is, if you use OR - use brackets. Whilst we are 
150 here CASE is not important. 'And BY_Zone' is just the same as 'and by_zone'.
151 <P>As mentioned earlier, setting several filters can be more flexible than 
152 simply setting one complex one.  Doing it in this way means that if you want 
153 to alter your filter you can just redefine or remove one or more lines of it or 
154 one line. For example ...
155 <P>
156 <BLOCKQUOTE><CODE>
157 <PRE>
158 reject/spots 1 on hf/ssb
159 </PRE>
160 </CODE></BLOCKQUOTE>
161 <P>would redefine our earlier example, or 
162 <P>
163 <BLOCKQUOTE><CODE>
164 <PRE>
165 clear/spots 1
166 </PRE>
167 </CODE></BLOCKQUOTE>
168 <P>To remove all the filter lines in the spot filter ...
169 <P>
170 <BLOCKQUOTE><CODE>
171 <PRE>
172 clear/spots all
173 </PRE>
174 </CODE></BLOCKQUOTE>
175 <P>
176 <H2><A NAME="ss7.3">7.3 Filter options</A>
177 </H2>
178
179 <P>You can filter in several different ways.  The options are listed in the
180 various helpfiles for accept, reject and filter.
181 <P>
182 <H2><A NAME="ss7.4">7.4 Default filters</A>
183 </H2>
184
185 <P>Sometimes all that is needed is a general rule for node connects.  This can
186 be done with a node_default filter.  This rule will always be followed, even
187 if the link is isolated, unless another filter is set specifically.  Default
188 rules can be set for nodes and users.  They can be set for spots, announces,
189 WWV and WCY.  They can also be used for hops.  An example might look like 
190 this ...
191 <P>
192 <BLOCKQUOTE><CODE>
193 <PRE>
194 accept/spot node_default by_zone 14,15,16,20,33
195 set/hops node_default spot 50
196 </PRE>
197 </CODE></BLOCKQUOTE>
198 <P>This filter is for spots only, you could set others for announce, WWV and WCY.
199 This filter would work for ALL nodes unless a specific filter is written to 
200 override it for a particular node.  You can also set a user_default should
201 you require.  It is important to note that default filters should be
202 considered to be "connected".  By this I mean that should you override the
203 default filter for spots, you need to add a rule for the hops for spots also.
204 <P>
205 <H2><A NAME="ss7.5">7.5 Advanced filtering</A>
206 </H2>
207
208 <P>Once you are happy with the results you get, you may like to experiment. 
209 <P>
210 <P>The previous example that filters hf/cw spots and accepts vhf/uhf spots from EU 
211 can be written with a mixed filter, for example ... 
212 <P>
213 <BLOCKQUOTE><CODE>
214 <PRE>
215 rej/spot on hf/cw
216 acc/spot on 0/30000
217 acc/spot 2 on 50000/1400000 and (by_zone 14,15,16 or call_zone 14,15,16)
218 </PRE>
219 </CODE></BLOCKQUOTE>
220 <P>Note that the first filter has not been specified with a number.  This will 
221 automatically be assumed to be number 1.  In this case, we have said <EM>reject all
222 HF spots in the CW section of the bands but accept all others at HF.  Also
223 accept anything in VHF and above spotted in or by operators in the zones
224 14, 15 and 16</EM>.  Each filter slot actually has a 'reject' slot and 
225 an 'accept' slot. The reject slot is executed BEFORE the accept slot.
226 <P>
227 <P>It was mentioned earlier that after a reject test that doesn't match, the default 
228 for following tests is 'accept', the reverse is true for 'accept'. In the example 
229 what happens is that the reject is executed first, any non hf/cw spot is passed 
230 to the accept line, which lets through everything else on HF.  The next filter line 
231 lets through just VHF/UHF spots from EU.
232 <P>
233 <P>
234 <HR>
235 <A HREF="adminmanual-8.html">Next</A>
236 <A HREF="adminmanual-6.html">Previous</A>
237 <A HREF="adminmanual.html#toc7">Contents</A>
238 </BODY>
239 </HTML>