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