File: networking.py

package info (click to toggle)
wicd 1.7.4+tb2-5~deb9u1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 4,240 kB
  • sloc: python: 11,062; sh: 774; makefile: 40
file content (1280 lines) | stat: -rw-r--r-- 45,430 bytes parent folder | download | duplicates (2)
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
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
#!/usr/bin/env python
# -*- coding: utf-8 -*-

""" networking - Provides wrappers for common network operations

This module provides wrappers of the common network tasks as well as
threads to perform the actual connecting to networks.

class Controller() -- Parent class to Wireless and Wired
class ConnectThread() -- Parent class to WirelessConnectThread and
    WiredConnectThread
class Wireless() -- Wrapper for various wireless functions
class Wired() -- Wrapper for various wired functions
class WirelessConnectThread() -- Connection thread for wireless
    interface
class WiredConnectThread() -- Connection thread for wired
    interface

"""

#
#   Copyright (C) 2007 - 2009 Adam Blackburn
#   Copyright (C) 2007 - 2009 Dan O'Reilly
#   Copyright (C) 2007 - 2009 Byron Hillis
#   Copyright (C)        2009 Andrew Psaltis
#
#   This program is free software; you can redistribute it and/or modify
#   it under the terms of the GNU General Public License Version 2 as
#   published by the Free Software Foundation.
#
#   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, see <http://www.gnu.org/licenses/>.
#

#
# Much thanks to wieman01 for help and support with various types of encyption.
# Also thanks to foxy123, yopnono, and the many others who reported bugs helped
# and helped keep this project moving.
#

import re
import time
import threading
import os
from signal import SIGTERM

# wicd imports 
import misc
import wpath
from backend import BackendManager
from translations import _

if __name__ == '__main__':
    wpath.chdir(__file__)

BACKEND = None
BACKEND_MGR = BackendManager()

def abortable(func):
    """ Mark a method in a ConnectionThread as abortable. 
    
    This decorator runs a check that will abort the connection thread
    if necessary before running a given method.
    
    """
    def wrapper(self, *__args, **__kargs):
        self.abort_if_needed()
        return func(self, *__args, **__kargs)
    
    wrapper.__name__ = func.__name__
    wrapper.__dict__ = func.__dict__
    wrapper.__doc__ = func.__doc__
    wrapper.__module = func.__module__
    return wrapper

def get_backend_list():
    """ Returns a list of available backends. """
    if BACKEND_MGR:
        return BACKEND_MGR.get_available_backends()
    else:
        return [""]
    
def get_backend_update_interval():
    """ Returns the suggested connection status update interval. """
    if BACKEND_MGR:
        return BACKEND_MGR.get_update_interval()
    else:
        return 5  # Seconds, this should never happen though.
    
def get_current_backend():
    """ Returns the current backend instance. """
    if BACKEND_MGR:
        return BACKEND_MGR.get_current_backend()
    else:
        return None
    
def get_backend_description(backend_name):
    """ Returns the description of the currently loaded backend. """
    return BACKEND_MGR.get_backend_description(backend_name)

def get_backend_description_dict():
    """ Returns a dict of all available backend descriptions. """
    d = {}
    for be in get_backend_list():
        if be:
            d[be] = get_backend_description(be)
    return d

def expand_script_macros(script, msg, bssid, essid):
    """Expands any supported macros in a script.

    Keyword arguments:
    script -- the script to execute.
    msg -- the name of the script, %{script} will be expanded to this.
    bssid -- the bssid of the network we connect to, defaults to 'wired'.
    essid -- the essid of the network we connect to, defaults to 'wired'.
    
    """
    def repl(match):
        macro = match.group(1).lower()
        if macro_dict.has_key(macro):
            return macro_dict[macro]
        print 'Warning: found illegal macro %s in %s script' % (macro, msg)
        return match.group()
    
    macro_dict = { 'script' : msg,
             'bssid' : bssid,
             'essid' : essid }
    regex = re.compile(r'%\{([a-zA-Z0-9]+)\}')
    expanded = regex.sub(repl, script)
    print "Expanded '%s' to '%s'" % (script, expanded)
    return expanded

 
class Controller(object):
    """ Parent class for the different interface types. """
    def __init__(self, debug=False):
        """ Initialise the class. """
        self.global_dns_1 = None
        self.global_dns_2 = None
        self.global_dns_3 = None
        self.global_dns_dom = None
        self.global_search_dom = None
        self._dhcp_client = None
        self._flush_tool = None
        self._debug = debug
        self._backend = None
        self.connecting_thread = None
        self.before_script = None
        self.after_script = None
        self.pre_disconnect_script = None
        self.post_disconnect_script = None
        self.driver = None
        self.iface = None
    
    def get_debug(self):
        """ Getter for debug property. """
        return self._debug
    def set_debug(self, value):
        """ Setter for debug property. """
        self._debug = value
        if self.iface:
            self.iface.SetDebugMode(value)
    debug = property(get_debug, set_debug)
    
    def set_dhcp_client(self, value):
        """ Setter for dhcp_client property. """
        self._dhcp_client = value
        if self.iface:
            self.iface.DHCP_CLIENT = value
    def get_dhcp_client(self):
        """ Getter for dhcp_client property. """
        return self._dhcp_client
    dhcp_client = property(get_dhcp_client, set_dhcp_client)
    
    def set_flush_tool(self, value):
        """ Setter for flush_tool property. """
        self._flush_tool = value
        if self.iface:
            self.iface.flush_tool = value
    def get_flush_tool(self):
        """ Getter for flush_tool property. """
        return self._flush_tool
    flush_tool = property(get_flush_tool, set_flush_tool)
    
    def LoadBackend(self, backend_name):
        """ Load the given networking backend. """
        global BACKEND
        if backend_name == self._backend:
            return
        self._backend = BACKEND_MGR.load_backend(backend_name)
        BACKEND = self._backend
        
    def NeedsExternalCalls(self):
        """ Returns true if the loaded backend needs external calls. """
        if self._backend:
            return self._backend.NeedsExternalCalls()
        else:
            return True
        
    def GetIP(self, ifconfig=""):
        """ Get the IP of the interface.

        Returns:
        The IP address of the interface in dotted notation.

        """
        return self.iface.GetIP(ifconfig)

    def Disconnect(self, nettype, name, mac):
        """ Disconnect from the network. """
        iface = self.iface
        # mac and name need to be strings
        if mac in (None, ''):
            mac = 'X'
        if name in (None, ''):
            name = 'X'
        os.putenv("MODE", "stop")
        os.putenv("VERBOSITY", str(int(self.debug)))
        os.putenv("IFACE", iface.iface)
        os.putenv("LOGICAL", iface.iface)
        os.putenv("PHASE", "pre-down")
        misc.ExecuteScripts('/etc/network/if-down.d/', self.debug)
        misc.ExecuteScripts(wpath.predisconnectscripts, self.debug,
                           extra_parameters=(nettype, name, mac))
        if self.pre_disconnect_script:
            print 'Running pre-disconnect script'
            misc.ExecuteScript(expand_script_macros(self.pre_disconnect_script,
                                                    'pre-disconnection',
                                                    mac, name),
                               self.debug)
        iface.ReleaseDHCP()
        iface.SetAddress('0.0.0.0')
        iface.FlushRoutes()
        iface.FlushDNS()
        iface.Down()
        iface.Up()
        os.putenv("PHASE", "post-down")
        misc.ExecuteScripts('/etc/network/if-post-down.d/', self.debug)
        misc.ExecuteScripts(wpath.postdisconnectscripts, self.debug,
                            extra_parameters=(nettype, name, mac))
        if self.post_disconnect_script:
            print 'Running post-disconnect script'
            misc.ExecuteScript(expand_script_macros(self.post_disconnect_script,
                                                    'post-disconnection',
                                                   mac, name),
                               self.debug)
        
    def ReleaseDHCP(self):
        """ Release the DHCP lease for this interface. """
        return self.iface.ReleaseDHCP()
    
    def KillDHCP(self):
        """ Kill the managed DHCP client if its in a connecting state. """
        print 'running kill dhcp.'
        if (self.connecting_thread.is_connecting and 
            self.iface.dhcp_object):
            if self.iface.dhcp_object.poll() is None:
                os.kill(self.iface.dhcp_object.pid, SIGTERM)
                self.iface.dhcp_object = None
    
    def IsUp(self):
        """ Calls the IsUp method for the wired interface.
        
        Returns:
        True if the interface is up, False otherwise.
        
        """
        return self.iface.IsUp()
    
    def EnableInterface(self):
        """ Puts the interface up.
        
        Returns:
        True if the interface was put up succesfully, False otherwise.
        
        """
        return self.iface.Up()
    
    def DisableInterface(self):
        """ Puts the interface down.
        
        Returns:
        True if the interface was put down succesfully, False otherwise.
        
        """
        return self.iface.Down()
    
    def AppAvailable(self, app):
        """ Determine if the given application is installed. """
        return self.iface.AppAvailable(app)
    

class ConnectThread(threading.Thread):
    """ A class to perform network connections in a multi-threaded way.

    Useless on it's own, this class provides the generic functions
    necessary for connecting using a separate thread.
    
    """

    is_connecting = None
    should_die = False
    lock = threading.Lock()

    def __init__(self, network, interface_name, before_script, after_script, 
                 pre_disconnect_script, post_disconnect_script, gdns1,
                 gdns2, gdns3, gdns_dom, gsearch_dom, iface,
                 debug):
        """ Initialise the required object variables and the thread.

        Keyword arguments:
        network -- the network to connect to
        wireless -- name of the wireless interface
        wired -- name of the wired interface
        before_script -- script to run before bringing up the interface
        after_script -- script to run after bringing up the interface
        pre_disconnect_script -- script to run before disconnection
        post_disconnect_script -- script to run after disconnection
        gdns1 -- global DNS server 1
        gdns2 -- global DNS server 2
        gdns3 -- global DNS server 3
        debug -- debug mode status

        """
        threading.Thread.__init__(self)
        self.network = network
        self.is_connecting = False
        self.is_aborted = False
        self.connect_result = None
        self.before_script = before_script
        self.after_script = after_script
        self.pre_disconnect_script = pre_disconnect_script
        self.post_disconnect_script = post_disconnect_script
        self._should_die = False
        self.abort_reason = ""
        self.connect_result = ""

        self.global_dns_1 = gdns1
        self.global_dns_2 = gdns2
        self.global_dns_3 = gdns3
        self.global_dns_dom = gdns_dom
        self.global_search_dom = gsearch_dom

        self.iface = iface

        self.connecting_status = None
        self.debug = debug
        
        self.SetStatus('interface_down')

    def _connect(self):
        raise NotImplementedError

    def run(self):
        self.connect_result = "failed"
        try:
            self._connect()
        finally:
            self.is_connecting = False
        
    def set_should_die(self, val):
        """ Setter for should_die property. """
        self.lock.acquire()
        try:
            self._should_die = val
        finally:
            self.lock.release()
    def get_should_die(self):
        """ Getter for should_die property. """
        return self._should_die
    should_die = property(get_should_die, set_should_die)

    def SetStatus(self, status):
        """ Set the threads current status message in a thread-safe way.

        Keyword arguments:
        status -- the current connection status

        """
        self.lock.acquire()
        try:
            self.connecting_status = status
        finally:
            self.lock.release()

    def GetStatus(self):
        """ Get the threads current status message in a thread-safe way.

        Returns:
        The current connection status.

        """
        self.lock.acquire()
        try:
            status = self.connecting_status
        finally:
            self.lock.release()
        return status
    
    @abortable
    def reset_ip_addresses(self, iface):
        """ Resets the IP addresses for both wired/wireless interfaces.
        
        Sets a false ip so that when we set the real one, the correct
        routing entry is created.
        
        """
        print 'Setting false IP...'
        self.SetStatus('resetting_ip_address')
        iface.SetAddress('0.0.0.0')
    
    @abortable
    def put_iface_down(self, iface):
        """ Puts the given interface down. """
        print 'Putting interface down'
        self.SetStatus('interface_down')
        iface.Down()
        
    @abortable
    def run_global_scripts_if_needed(self, script_dir, extra_parameters=()):
        """ Run global scripts if needed. '"""
        misc.ExecuteScripts(script_dir, verbose=self.debug,
                            extra_parameters=extra_parameters)

    @abortable
    def run_script_if_needed(self, script, msg, bssid='wired', essid='wired'):
        """ Execute a given script if needed.
        
        Keyword arguments:
        script -- the script to execute, or None/'' if there isn't one.
        msg -- the name of the script to display in the log.
        
        """
        if script:
            print 'Executing %s script' % (msg)
            misc.ExecuteScript(expand_script_macros(script, msg, bssid, essid),
                               self.debug)
        
    @abortable
    def flush_routes(self, iface):
        """ Flush the routes for both wired/wireless interfaces. """
        self.SetStatus('flushing_routing_table')
        print 'Flushing the routing table...'
        iface.FlushRoutes()
        
    @abortable
    def set_broadcast_address(self, iface):
        """ Set the broadcast address for the given interface. """
        if not self.network.get('broadcast') == None:
            self.SetStatus('setting_broadcast_address')
            print 'Setting the broadcast address...' + self.network['broadcast']
            iface.SetAddress(broadcast=self.network['broadcast'])
        
    @abortable
    def set_ip_address(self, iface):
        """ Set the IP address for the given interface. 
        
        Assigns a static IP if one is requested, otherwise calls DHCP.
        
        """
        if self.network.get('ip'):
            self.SetStatus('setting_static_ip')
            print 'Setting static IP : ' + self.network['ip']
            iface.SetAddress(self.network['ip'], self.network['netmask'])
            if self.network.get('gateway'):
                print 'Setting default gateway : ' + self.network['gateway']
                iface.SetDefaultRoute(self.network['gateway'])
        else:
            # Run dhcp...
            self.SetStatus('running_dhcp')
            if self.network.get('usedhcphostname') == None:
                self.network['usedhcphostname'] = False
            if self.network.get('dhcphostname') == None:
                self.network['dhcphostname'] = os.uname()[1]
            if self.network['usedhcphostname']:
                hname = self.network['dhcphostname']
                print "Running DHCP with hostname", hname
            else:
                hname = None
                print "Running DHCP with NO hostname"
            
            # Check if a global DNS is configured. If it is, then let the DHCP know *not* to update resolv.conf
            staticdns = False
            if self.network.get('use_global_dns') or (self.network.get('use_static_dns') and (self.network.get('dns1') or self.network.get('dns2') or self.network.get('dns3'))):
                staticdns = True

            dhcp_status = iface.StartDHCP(hname, staticdns)
            if dhcp_status in ['no_dhcp_offers', 'dhcp_failed']:
                if self.connect_result != "aborted":
                    self.abort_connection(dhcp_status)
                return

    @abortable
    def flush_dns_addresses(self, iface):
        """ Flush the added DNS address(es).

        This is only useful when using resolvconf, since we effectively have no
        foolproof way of removing added DNS addresses from a non-resolvconf
        setup.

        """
        iface.FlushDNS()

    @abortable
    def set_dns_addresses(self, iface):
        """ Set the DNS address(es).

        If static DNS servers or global DNS servers are specified, set them.
        Otherwise do nothing.
        
        """
        if self.network.get('use_global_dns'):
            iface.SetDNS(misc.Noneify(self.global_dns_1),
                         misc.Noneify(self.global_dns_2), 
                         misc.Noneify(self.global_dns_3),
                         misc.Noneify(self.global_dns_dom),
                         misc.Noneify(self.global_search_dom))
        elif self.network.get('use_static_dns') and (self.network.get('dns1') or
                    self.network.get('dns2') or self.network.get('dns3')):
            self.SetStatus('setting_static_dns')
            iface.SetDNS(self.network.get('dns1'),
                         self.network.get('dns2'),
                         self.network.get('dns3'),
                         self.network.get('dns_domain'),
                         self.network.get('search_domain'))

    @abortable
    def release_dhcp_clients(self, iface):
        """ Release all running dhcp clients. """
        print "Releasing DHCP leases..."
        iface.ReleaseDHCP()
        
    def connect_aborted(self, reason):
        """ Sets the thread status to aborted. """
        if self.abort_reason:
            reason = self.abort_reason
        self.connecting_status = reason
        self.is_aborted = True
        self.connect_result = reason
        self.is_connecting = False
        print 'exiting connection thread'
        
    def abort_connection(self, reason=""):
        """ Schedule a connection abortion for the given reason. """
        self.abort_reason = reason
        self.should_die = True
        
    def abort_if_needed(self):
        """ Abort the thread is it has been requested. """
        self.lock.acquire()
        try:
            if self._should_die:
                self.connect_aborted('aborted')
                raise SystemExit
        finally:
            self.lock.release()
        
    @abortable
    def stop_wpa(self, iface):
        """ Stops wpa_supplicant. """
        print 'Stopping wpa_supplicant'
        iface.StopWPA()
        
    @abortable
    def put_iface_up(self, iface):
        """ Bring up given interface. """
        print 'Putting interface up...'
        self.SetStatus('interface_up')
        iface.Up()
        for x in range(0, 5):
            time.sleep(2)
            if iface.IsUp():
                return
            self.abort_if_needed()
         
        # If we get here, the interface never came up
        print "WARNING: Timed out waiting for interface to come up"


class Wireless(Controller):
    """ A wrapper for common wireless interface functions. """

    def __init__(self, debug=False):
        """ Initialize the class. """
        Controller.__init__(self, debug=debug)
        self._wpa_driver = None
        self._wireless_interface = None
        self.wiface = None 
        self.should_verify_ap = True
        
    def set_wireless_iface(self, value):
        """ Setter for wireless_interface property. """
        self._wireless_interface = value
        if self.wiface:
            self.wiface.SetInterface(value)
    def get_wireless_iface(self):
        """ Getter for wireless_interface property. """
        return self._wireless_interface
    wireless_interface = property(get_wireless_iface, set_wireless_iface) 
        
    def set_wpa_driver(self, value):
        """ Setter for wpa_driver property. """
        self._wpa_driver = value
        if self.wiface:
            self.SetWPADriver(value)
    def get_wpa_driver(self):
        """ Getter for wpa_driver property. """
        return self._wpa_driver
    wpa_driver = property(get_wpa_driver, set_wpa_driver)
    
    def set_iface(self, value):
        """ Setter for iface property. """
        self.wiface = value
    def get_iface(self):
        """ Getter for iface property. """
        return self.wiface
    iface = property(get_iface, set_iface)
        
    def LoadBackend(self, backend):
        """ Load a given backend. 

        Load up a backend into the backend manager and associate with
        the networking interface.
        
        """
        Controller.LoadBackend(self, backend)
        backend = self._backend
        if backend:
            self.wiface = backend.WirelessInterface(self.wireless_interface,
                                                    self.debug, self.wpa_driver)

    def Scan(self, essid=None):
        """ Scan for available wireless networks.

        Keyword arguments:
        essid -- The essid of a hidden network

        Returns:
        A list of available networks sorted by strength.

        """
        def comp(x, y):
            """ Custom sorting function. """
            if 'quality' in x:
                key = 'quality'
            else:
                key = 'strength'
            return cmp(x[key], y[key])
                
        if not self.wiface:
            return []
        wiface = self.wiface

        # Prepare the interface for scanning
        wiface.Up()

        # If there is a hidden essid then set it now, so that when it is
        # scanned it will be recognized.
        # Note: this does not always work, sometimes we have to pass it with "iwlist wlan0 scan essid -- XXXXX"
        essid = misc.Noneify(essid)
        if essid is not None:
            print 'Setting hidden essid ' + essid
            wiface.SetEssid(essid)
            # sleep for a bit; scanning to fast will result in nothing
            time.sleep(1)

        aps = wiface.GetNetworks(essid)
        aps.sort(cmp=comp, reverse=True)
        
        return aps

    def Connect(self, network, debug=False):
        """ Spawn a connection thread to connect to the network.

        Keyword arguments:
        network -- network to connect to

        """
        if not self.wiface:
            return False
        
        self.connecting_thread = WirelessConnectThread(network,
            self.wireless_interface, self.wpa_driver, self.before_script,
            self.after_script, self.pre_disconnect_script,
            self.post_disconnect_script, self.global_dns_1,
            self.global_dns_2, self.global_dns_3, self.global_dns_dom,
            self.global_search_dom, self.wiface, self.should_verify_ap,
            self.bitrate, self.allow_lower_bitrates, debug)
        self.connecting_thread.setDaemon(True)
        self.connecting_thread.start()
        return True

    def GetSignalStrength(self, iwconfig=""):
        """ Get signal strength of the current network.

        Returns:
        The current signal strength.

        """
        return self.wiface.GetSignalStrength(iwconfig)

    def GetDBMStrength(self, iwconfig=""):
        """ Get the dBm signal strength of the current network.

        Returns:
        The current dBm signal strength.

        """
        return self.wiface.GetDBMStrength(iwconfig)

    def GetCurrentNetwork(self, iwconfig=""):
        """ Get current network name.

        Returns:
        The name of the currently connected network.

        """
        if self.connecting_thread and self.connecting_thread.is_connecting:
            return self.connecting_thread.network['essid']
        return self.wiface.GetCurrentNetwork(iwconfig)
    
    def GetBSSID(self):
        """ Get the BSSID of the current access point. 
        
        Returns:
        The MAC Adress of the active access point as a string, or
        None the BSSID can't be found.
        
        """
        return self.wiface.GetBSSID()

    def GetCurrentBitrate(self, iwconfig):
        """ Get the current bitrate of the interface. 
        
        Returns:
        The bitrate of the active access point as a string, or
        None the bitrate can't be found.
        
        """
        return self.wiface.GetCurrentBitrate(iwconfig)

    def GetOperationalMode(self, iwconfig):
        """ Get the current operational mode of the interface. 
        
        Returns:
        The operational mode of the interface as a string, or
        None if the operational mode can't be found.
        
        """
        return self.wiface.GetOperationalMode(iwconfig)

    def GetAvailableAuthMethods(self, iwlistauth):
        """ Get the available authentication methods for the interface. 
        
        Returns:
        The available authentication methods of the interface as a string, or
        None if the auth methods can't be found.
        
        """
        return self.wiface.GetAvailableAuthMethods(iwlistauth)

    def GetAvailableBitrates(self):
        """ Get the available bitrates for the interface.

        Returns:
        The available bitrates of the interface as a string, or None if the
        bitrates can't be found.
        """
        return self.wiface.GetAvailableBitrates()

    def GetIwconfig(self):
        """ Get the out of iwconfig. """
        return self.wiface.GetIwconfig()
    
    def GetWpaSupplicantDrivers(self):
        """ Returns all valid wpa_supplicant drivers on the system. """
        return BACKEND.GetWpaSupplicantDrivers()
    
    def StopWPA(self):
        """ Stop wpa_supplicant. """
        return self.wiface.StopWPA()

    def CreateAdHocNetwork(self, essid, channel, ip, enctype, key,
            enc_used):
        """ Create an ad-hoc wireless network.

        Keyword arguments:
        essid -- essid of the ad-hoc network
        channel -- channel of the ad-hoc network
        ip -- ip of the ad-hoc network
        enctype -- unused
        key -- key of the ad-hoc network
        enc_used -- encrytion enabled on ad-hoc network

        """
        wiface = self.wiface
        print 'Creating ad-hoc network'
        print 'Stopping dhcp client and wpa_supplicant'
        wiface.ReleaseDHCP()
        wiface.StopWPA()
        print 'Putting wireless interface down'
        wiface.Down()
        print 'Setting mode, channel, and essid'
        wiface.SetMode('ad-hoc')
        wiface.SetChannel(channel)
        wiface.SetEssid(essid)
        # Right now it just assumes you're using WEP
        if enc_used:
            print 'Setting encryption key'
            wiface.SetKey(key)
        print 'Putting interface up'
        wiface.Up()
        print 'Setting IP address'
        wiface.SetAddress(ip, '255.255.255.0')

    def DetectWirelessInterface(self):
        """ Detect available wireless interfaces.

        Returns:
        The first available wireless interface.

        """
        ifaces = BACKEND.GetWirelessInterfaces()
        if ifaces:
            return ifaces[0]
        else:
            return None

    def GetKillSwitchStatus(self):
        """ Get the current status of the Killswitch. 
        
        Returns:
        True if the killswitch is on, False otherwise.
        
        """
        return self.wiface.GetKillSwitchStatus()

    def SwitchRfKill(self):
        """ Switches the rfkill on/off for wireless cards. """
        types = ['wifi', 'wlan', 'wimax', 'wwan']
        try:
            if self.GetRfKillStatus():
                action = 'unblock'
            else:
                action = 'block'
            for t in types:
                cmd = ['rfkill', action, t]
                print "rfkill: %sing %s" % (action, t)
                misc.Run(cmd)
            return True
        except Exception, e:
            raise e
            return False

    def GetRfKillStatus(self):
        """ Determines if rfkill switch is active or not.

        Returns:
        True if rfkill (soft-)switch is enabled.
        """
        cmd = 'rfkill list'
        rfkill_out = misc.Run(cmd)
        soft_blocks = filter(lambda x: x.startswith('Soft'),
            rfkill_out.split('\t'))
        for line in map(lambda x: x.strip(), soft_blocks):
            if line.endswith('yes'):
                return True
        return False

    def Disconnect(self):
        """ Disconnect the given iface.
        
        Executes the disconnect script associated with a given interface,
        Resets it's IP address, and puts the interface down then up.
        
        """
        if BACKEND.NeedsExternalCalls():
            iwconfig = self.GetIwconfig()
        else:
            iwconfig = None
        bssid = self.wiface.GetBSSID(iwconfig)
        essid = self.wiface.GetCurrentNetwork(iwconfig) 

        Controller.Disconnect(self, 'wireless', essid, bssid)
        self.StopWPA()
    
    def SetWPADriver(self, driver):
        """ Sets the wpa_supplicant driver associated with the interface. """
        self.wiface.SetWpaDriver(driver)

 
class WirelessConnectThread(ConnectThread):
    """ A thread class to perform the connection to a wireless network.

    This thread, when run, will perform the necessary steps to connect
    to the specified network.

    """

    def __init__(self, network, wireless, wpa_driver, before_script,
                 after_script, pre_disconnect_script, post_disconnect_script,
                 gdns1, gdns2, gdns3, gdns_dom, gsearch_dom, wiface, 
                 should_verify_ap, bitrate, allow_lower_bitrates, debug=False):
        """ Initialise the thread with network information.

        Keyword arguments:
        network -- the network to connect to
        wireless -- name of the wireless interface
        wpa_driver -- type of wireless interface
        before_script -- script to run before bringing up the interface
        after_script -- script to run after bringing up the interface
        pre_disconnect_script -- script to run before disconnection
        post_disconnect_script -- script to run after disconnection
        gdns1 -- global DNS server 1
        gdns2 -- global DNS server 2
        gdns3 -- global DNS server 3
        bitrate -- chosen interface bitrate
        allow_lower_bitrates -- whether to allow lower bitrates or not

        """
        ConnectThread.__init__(self, network, wireless, before_script, 
                               after_script, pre_disconnect_script,
                               post_disconnect_script, gdns1, gdns2,
                               gdns3, gdns_dom, gsearch_dom, wiface, debug)
        self.wpa_driver = wpa_driver
        self.should_verify_ap = should_verify_ap
        self.bitrate = bitrate
        self.allow_lower_bitrates = allow_lower_bitrates

    def _connect(self):
        """ The main function of the connection thread.

        This function performs the necessary calls to connect to the
        specified network, using the information provided. The following
        indicates the steps taken.
        1. Run pre-connection script.
        2. Take down the interface and clean up any previous
           connections.
        3. Generate a PSK if required and authenticate.
        4. Associate with the WAP.
        5. Get/set IP address and DNS servers.

        """
        wiface = self.iface
        self.is_connecting = True
        
        # Run pre-connection script.
        os.putenv("MODE", "start")
        os.putenv("VERBOSITY", str(int(self.debug)))
        os.putenv("IFACE", wiface.iface)
        os.putenv("LOGICAL", wiface.iface)
        os.putenv("PHASE", "pre-up")
        self.run_global_scripts_if_needed('/etc/network/if-pre-up.d/')
        self.run_global_scripts_if_needed(wpath.preconnectscripts,
                                          extra_parameters=('wireless',
                                                    self.network['essid'],
                                                    self.network['bssid'])
                                         )
        self.run_script_if_needed(self.before_script, 'pre-connection', 
                                  self.network['bssid'], self.network['essid'])

        
        # Take down interface and clean up previous connections.
        self.put_iface_down(wiface)
        self.release_dhcp_clients(wiface)
        self.reset_ip_addresses(wiface)
        self.stop_wpa(wiface)
        self.flush_routes(wiface)
        self.flush_dns_addresses(wiface)
        wiface.SetMode(self.network['mode'])
        wiface.SetBitrate(self.bitrate, self.allow_lower_bitrates)

        # Put interface up.
        self.SetStatus('configuring_interface')
        self.put_iface_up(wiface)
        
        # Generate PSK and authenticate if needed.
        if self.wpa_driver != 'ralink legacy':
            self.generate_psk_and_authenticate(wiface)
            
        # Associate.
        wiface.Associate(self.network['essid'], self.network['channel'],
                         self.network['bssid'])

        # Authenticate after association for Ralink legacy cards.
        if self.wpa_driver == 'ralink legacy':
            if self.network.get('key'):
                wiface.Authenticate(self.network)
                
        # Validate Authentication.
        if self.network.get('enctype'):
            self.SetStatus('validating_authentication')
            if not wiface.ValidateAuthentication(time.time()):
                print "connect result is %s" % self.connect_result
                if not self.connect_result or self.connect_result == 'failed':
                    self.abort_connection('bad_pass')

        # Set up gateway, IP address, and DNS servers.
        self.set_broadcast_address(wiface)
        self.set_ip_address(wiface)
        self.set_dns_addresses(wiface)
        self.verify_association(wiface)
        
        # Run post-connection script.
        os.putenv("PHASE", "post-up")
        self.run_global_scripts_if_needed('/etc/network/if-up.d/')
        self.run_global_scripts_if_needed(wpath.postconnectscripts,
                                          extra_parameters=('wireless',
                                                    self.network['essid'],
                                                    self.network['bssid'])
                                         )
        self.run_script_if_needed(self.after_script, 'post-connection', 
                                  self.network['bssid'], self.network['essid'])

        self.SetStatus('done')
        print 'Connecting thread exiting.'
        if self.debug:
            print "IP Address is: " + str(wiface.GetIP())
        self.connect_result = "success"
        self.is_connecting = False
        
    @abortable
    def verify_association(self, iface):
        """ Verify that our association the AP is valid.
        
        Try to ping the gateway we have set to see if we're
        really associated with it.  This is only done if
        we're using a static IP.
        
        """
        if self.network.get('gateway') and self.should_verify_ap:
            self.SetStatus('verifying_association')
            print "Verifying AP association..."
            for tries in range(1, 11):
                print "Attempt %d of 10..." % tries
                retcode = self.iface.VerifyAPAssociation(self.network['gateway'])
                if retcode == 0: 
                    print "Successfully associated."
                    break
                time.sleep(1)
            #TODO this should be in wnettools.py
            if retcode:
                print "Connection Failed: Failed to ping the access point!"
                # Clean up before aborting.
                iface.SetAddress('0.0.0.0')
                iface.FlushRoutes()
                iface.FlushDNS()
                if hasattr(iface, "StopWPA"):
                    iface.StopWPA()
                self.abort_connection('association_failed')
        else:
            print 'not verifying'
        
    @abortable
    def generate_psk_and_authenticate(self, wiface):
        """ Generates a PSK and authenticates if necessary. 
        
        Generates a PSK, and starts the authentication process
        if encryption is on.
        
        """
        # Check to see if we need to generate a PSK (only for non-ralink
        # cards).
        if self.debug:
            print "enctype is %s" % self.network.get('enctype')
        if self.network.get('key') and \
           'wpa' in str(self.network.get('enctype')):
            self.SetStatus('generating_psk')
            print 'Generating psk...'
            self.network['psk'] = wiface.GeneratePSK(self.network)
            
            if not self.network.get('psk'):
                self.network['psk'] = self.network['key']
                print 'WARNING: PSK generation failed!  Falling back to ' + \
                      'wireless key.\nPlease report this error to the wicd ' + \
                      'developers!'
        # Generate the wpa_supplicant file...
        if self.network.get('enctype'):
            self.SetStatus('generating_wpa_config')
            print 'Attempting to authenticate...'
            wiface.Authenticate(self.network)


class Wired(Controller):
    """ A wrapper for common wired interface functions. """

    def __init__(self, debug=False):
        """ Initialise the class. """
        Controller.__init__(self, debug=debug)
        self.wpa_driver = None
        self._link_detect = None
        self._wired_interface = None
        self.liface = None
        
    def set_link_detect(self, value):
        """ Setter for link_detect property. """
        self._link_detect = value
        if self.liface:
            self.liface.link_detect = value
    def get_link_detect(self):
        """ Getter for link_detect property. """
        return self._link_detect
    link_detect = property(get_link_detect, set_link_detect)
    
    
    def set_wired_iface(self, value):
        """ Setter for wired_interface property. """
        self._wired_interface = value
        if self.liface:
            self.liface.SetInterface(value)            
    def get_wired_iface(self):
        """ Getter for wired_interface property. """
        return self._wired_interface
    wired_interface = property(get_wired_iface, set_wired_iface)
    
    def set_iface(self, value):
        """ Setter for iface property. """
        self.liface = value
    def get_iface(self):
        """ Getter for iface property. """
        return self.liface
    iface = property(get_iface, set_iface)
    
    def LoadBackend(self, backend):
        """ Load the backend up. """
        Controller.LoadBackend(self, backend)
        if self._backend:
            self.liface = self._backend.WiredInterface(self.wired_interface,
                                                       self.debug)

    def CheckPluggedIn(self):
        """ Check whether the wired connection is plugged in.

        Returns:
        The status of the physical connection link.

        """
        return self.liface.GetPluggedIn()

    def Connect(self, network, debug=False):
        """ Spawn a connection thread to connect to the network.

        Keyword arguments:
        network -- network to connect to

        """
        if not self.liface:
            return False
        self.connecting_thread = WiredConnectThread(network,
            self.wired_interface, self.before_script, self.after_script,
            self.pre_disconnect_script, self.post_disconnect_script,
            self.global_dns_1, self.global_dns_2, self.global_dns_3,
            self.global_dns_dom, self.global_search_dom, self.liface,
            debug)
        self.connecting_thread.setDaemon(True)
        self.connecting_thread.start()
        return self.connecting_thread
    
    def Disconnect(self):
        Controller.Disconnect(self, 'wired', 'wired', 'wired')
        self.StopWPA()
    
    def StopWPA(self):
        """ Stop wpa_supplicant. """
        self.liface.StopWPA()
    
    def DetectWiredInterface(self):
        """ Attempts to automatically detect a wired interface. """
        try:
            return BACKEND.GetWiredInterfaces()[0]
        except IndexError:
            return None


class WiredConnectThread(ConnectThread):
    """ A thread class to perform the connection to a wired network.

    This thread, when run, will perform the necessary steps to connect
    to the specified network.

    """
    def __init__(self, network, wired, before_script, after_script, 
                 pre_disconnect_script, post_disconnect_script, gdns1,
                 gdns2, gdns3, gdns_dom, gsearch_dom, liface, debug=False):
        """ Initialise the thread with network information.

        Keyword arguments:
        network -- the network to connect to
        wireless -- name of the wireless interface
        wired -- name of the wired interface
        before_script -- script to run before bringing up the interface
        after_script -- script to run after bringing up the interface
        pre_disconnect_script -- script to run before disconnection
        post_disconnect_script -- script to run after disconnection
        gdns1 -- global DNS server 1
        gdns2 -- global DNS server 2
        gdns3 -- global DNS server 3

        """
        ConnectThread.__init__(self, network, wired, before_script, 
                               after_script, pre_disconnect_script,
                               post_disconnect_script, gdns1, gdns2,
                               gdns3, gdns_dom, gsearch_dom, liface,
                               debug)

    def _connect(self):
        """ The main function of the connection thread.

        This function performs the necessary calls to connect to the
        specified network, using the information provided. The following
        indicates the steps taken.
        1. Run pre-connection script.
        2. Take down the interface and clean up any previous
           connections.
        3. Bring up the interface.
        4. Get/set IP address and DNS servers.
        5. Run post-connection script.

        """
        liface = self.iface

        self.is_connecting = True

        # Run pre-connection script.
        os.putenv("MODE", "start")
        os.putenv("VERBOSITY", str(int(self.debug)))
        os.putenv("IFACE", liface.iface)
        os.putenv("LOGICAL", liface.iface)
        os.putenv("PHASE", "pre-up")
        self.run_global_scripts_if_needed('/etc/network/if-pre-up.d/')
        self.run_global_scripts_if_needed(wpath.preconnectscripts,
                                          extra_parameters=('wired', 'wired',
                                                    self.network['profilename'])
                                          )
        self.run_script_if_needed(self.before_script, 'pre-connection', 'wired',
                                  'wired')

        # Take down interface and clean up previous connections.
        self.put_iface_down(liface)
        self.release_dhcp_clients(liface)
        self.reset_ip_addresses(liface)
        self.stop_wpa(liface)
        self.flush_routes(liface)
        self.flush_dns_addresses(liface)
        
        # Bring up interface.
        self.put_iface_up(liface)
        
        # Manage encryption.
        if self.network.get('encryption_enabled'):
            liface.Authenticate(self.network)
        
        # Set gateway, IP adresses, and DNS servers.
        self.set_broadcast_address(liface)
        self.set_ip_address(liface)
        self.set_dns_addresses(liface)
        
        # Run post-connection script.
        os.putenv("PHASE", "post-up")
        self.run_global_scripts_if_needed('/etc/network/if-up.d/')
        self.run_global_scripts_if_needed(wpath.postconnectscripts,
                                          extra_parameters=('wired', 'wired',
                                                self.network['profilename'])
                                         )
        self.run_script_if_needed(self.after_script, 'post-connection', 'wired',
                                  'wired')

        self.SetStatus('done')
        print 'Connecting thread exiting.'
        if self.debug:
            print "IP Address is: " + str(liface.GetIP())
        
        self.connect_result = "success"
        self.is_connecting = False