source: trunk/src/halTorrent.hpp @ 661

Revision 661, 20.2 KB checked in by Eoin, 11 years ago (diff)

File list working but very slow.

Line 
1
2//         Copyright Eóin O'Callaghan 2006 - 2008.
3// Distributed under the Boost Software License, Version 1.0.
4//    (See accompanying file LICENSE_1_0.txt or copy at
5//          http://www.boost.org/LICENSE_1_0.txt)
6
7#pragma once
8
9/*#include <string>
10#include <vector>
11#include <set>
12
13#include <boost/foreach.hpp>
14#include <boost/format.hpp>
15#include <boost/array.hpp>
16#include <boost/lexical_cast.hpp>
17#include <boost/bind.hpp>
18
19#include <boost/smart_ptr.hpp>
20#include <boost/noncopyable.hpp>
21
22#include <boost/signal.hpp>
23#include <boost/optional.hpp>
24#include <boost/function.hpp>
25
26#include <boost/smart_ptr.hpp>
27
28#include <boost/filesystem/path.hpp>
29#include <boost/filesystem/operations.hpp>
30#include <boost/filesystem/fstream.hpp>
31*/
32
33#include <boost/algorithm/string.hpp>
34
35#include <stlsoft/properties/method_properties.hpp>
36#include <stlsoft/util/operator_bool_adaptor.hpp>
37
38#include <boost/asio/ip/tcp.hpp>
39#include <boost/asio/ip/udp.hpp>
40
41#include "halTypes.hpp"
42#include "halPeers.hpp"
43
44namespace hal
45{
46
47template<typename T>
48bool hal_details_ptr_compare(T l, T r, size_t index = 0, bool cmp_less = true)
49{
50        if (cmp_less)
51                return l->less(*r, index);
52        else
53                return r->less(*l, index);
54}
55
56template<typename T>
57bool hal_details_compare(T l, T r, size_t index = 0, bool cmp_less = true)
58{
59        if (cmp_less)
60                return l.less(r, index);
61        else
62                return r.less(l, index);
63}
64
65inline boost::wformat wform(const std::wstring & f_string) 
66{
67    using namespace boost::io;
68
69        boost::wformat fmter(f_string);
70    fmter.exceptions( no_error_bits  );
71    return fmter;
72}
73
74struct torrentBriefDetail
75{
76        std::wstring filename;
77        std::wstring status;
78        std::pair<float,float> speed;
79        float completion;
80        int peers;
81        int seeds;
82};
83
84struct queue_settings;
85struct timeouts;
86struct dht_settings;
87struct cache_settings;
88struct pe_settings;
89struct connections;
90struct cache_details;
91
92
93struct file_details
94{
95        enum details
96        {
97                branch_e = 0,
98                filename_e,
99                type_e,
100                size_e,
101                progress_e,
102                priority_e
103        };
104
105        file_details(boost::filesystem::wpath p, 
106                        boost::int64_t s=0, 
107                        boost::int64_t pg=0, 
108                        int pr=1, 
109                        size_t o=0, 
110                        unsigned t=file_details::file) :
111                branch(p.parent_path()),
112                filename(p.filename()),
113                type(t),
114                size(s),
115                progress(pg),
116                priority(pr),
117                order_(o)
118        {}
119       
120        bool operator==(const file_details& file) const
121        {
122                return (branch == file.branch);
123        }
124       
125        bool operator<(const file_details& file) const
126        {
127                return (branch < file.branch);
128        }
129       
130        bool less(const file_details& r, size_t index = 0) const;
131        std::wstring to_wstring(size_t index = 0);
132       
133        enum file_type
134        {
135                folder,
136                file
137        };
138       
139        size_t order() const { return order_; }
140       
141        boost::filesystem::wpath branch;
142        std::wstring filename;
143        unsigned type;
144        boost::int64_t size;
145        boost::int64_t progress;
146        int priority;
147       
148private:
149        size_t order_;
150};
151
152inline bool file_details_names_equal(const file_details& l, const file_details& r)
153{
154        return l.filename == r.filename;
155}
156
157inline bool file_details_names_less(const file_details& l, const file_details& r)
158{
159        return l.filename < r.filename;
160}
161
162typedef std::vector<file_details> file_details_vec;
163
164void file_details_sort(file_details_vec& f, size_t index, bool cmp_less = true);
165
166class torrent_details 
167{
168public:
169        torrent_details(std::wstring n, std::wstring f, 
170                        std::wstring sd, 
171                        std::wstring s, 
172                        std::wstring cT, 
173                        std::pair<float,float> sp=std::pair<float,float>(0,0),
174                        float c=0, float d=0, 
175                        size_type tWD=0, size_type tW=0, 
176                        size_type tU=0, size_type tpU=0, 
177                        size_type tD=0, size_type tpD=0, 
178                        boost::tuple<size_type, size_type, size_type, size_type> connections = 
179                                boost::tuple<size_type, size_type, size_type, size_type>(0,0,0,0), 
180                        float r=0, 
181                        boost::posix_time::time_duration eta=boost::posix_time::seconds(0), 
182                        boost::posix_time::time_duration uIn=boost::posix_time::seconds(0),
183                        boost::posix_time::time_duration actve=boost::posix_time::seconds(0), 
184                        boost::posix_time::time_duration seding=boost::posix_time::seconds(0), 
185                        boost::posix_time::ptime srt=boost::posix_time::second_clock::universal_time(), 
186                        boost::posix_time::ptime fin=boost::posix_time::second_clock::universal_time(), 
187                        int q_p=-1, 
188                        bool man=false) :
189                filename_(f),
190                name_(n),
191                saveDir_(sd),
192                state_(s),
193                currentTracker_(cT),
194                speed_(sp),
195                completion_(c),
196                distributed_copies_(d),
197                total_wanted_done_(tWD),
198                total_wanted_(tW),
199                total_uploaded_(tU),
200                total_payload_uploaded_(tpU),
201                total_downloaded_(tD),
202                total_payload_downloaded_(tpD),
203                peers_(connections.get<0>()),
204                connected_peers_(connections.get<1>()),
205                seeds_(connections.get<2>()),
206                connected_seeds_(connections.get<3>()),
207                ratio_(r),
208                estimated_time_left_(eta),
209                update_tracker_in_(uIn),
210                peer_details_filled_(false),
211                file_details_filled_(false),
212                active_(actve),
213                seeding_(seding),
214                start_time_(srt),
215                finish_time_(fin),
216                queue_position_(q_p),
217                managed_(man)
218        {}
219
220        torrent_details() :     
221                peer_details_filled_(false),
222                file_details_filled_(false)
223        {};     
224       
225        enum state
226        {
227                torrent_active = 0,
228                torrent_paused,
229                torrent_stopped,
230                torrent_pausing,
231                torrent_stopping
232        };
233
234        enum details
235        {
236                name_e = 0,
237                state_e,
238                progress_e,
239                speed_down_e,
240                speed_up_e,
241                peers_e,
242                seeds_e,
243                eta_e,
244                distributed_copies_e,
245                tracker,
246                update_tracker_in_e,
247                ratio_e,
248                total_wanted_e,
249                completed_e,
250                remaining_e,
251                downloaded_e,
252                uploaded_e,
253                active_time_e,
254                seeding_time_e,
255                start_time_e,
256                finish_time_e,
257                managed_e,
258                queue_position_e
259        };
260       
261//      const std::wstring& filename() const { return filename_; }
262        const std::wstring& name() const { return name_; }
263        const std::wstring& save_directory() const { return saveDir_; }
264        const std::wstring& state() const { return state_; }
265        const std::wstring& current_tracker() const { return currentTracker_; }
266       
267        std::pair<float,float> speed() const { return speed_; }
268        const float& completion() const { return completion_; }
269        const float& distributed_copies() const { return distributed_copies_; }
270       
271        size_type total_uploaded() const { return total_uploaded_; }
272        size_type total_payload_uploaded() const { return total_payload_uploaded_; }
273        size_type total_downloaded() const { return total_downloaded_; }
274        size_type total_payload_downloaded() const { return total_payload_downloaded_; }
275        size_type total_wanted_done() const { return total_wanted_done_; }
276        size_type total_wanted() const { return total_wanted_; }
277       
278        size_type peers() const { return peers_; }
279        size_type peers_connected() const { return connected_peers_; }
280        size_type seeds() const { return seeds_; }
281        size_type seeds_connected() const { return connected_seeds_; }
282       
283        float ratio() { return ratio_; }
284       
285        const boost::posix_time::time_duration& estimated_time_left() { return estimated_time_left_; }
286        const boost::posix_time::time_duration& update_tracker_in() { return update_tracker_in_; }
287       
288        const peer_details_vec& get_peer_details() const;
289        const file_details_vec& get_file_details() const;
290       
291        const boost::posix_time::time_duration& active() { return active_; }
292        const boost::posix_time::time_duration& seeding() { return seeding_; }
293        const boost::posix_time::ptime& start_time() { return start_time_; }
294        const boost::posix_time::ptime& finish_time() { return finish_time_; }
295
296        int queue_position() const { return queue_position_; }
297        bool managed() const { return managed_; }
298
299        bool less(const torrent_details& r, size_t index = 0) const;
300        std::wstring to_wstring(size_t index = 0);
301       
302public:
303        std::wstring filename_;
304        std::wstring name_;
305        std::wstring saveDir_;
306        std::wstring state_;
307        std::wstring currentTracker_;
308
309        std::pair<float,float> speed_;         
310        float completion_;     
311        float distributed_copies_;
312       
313        size_type total_wanted_done_;
314        size_type total_wanted_;
315        size_type total_uploaded_;
316        size_type total_payload_uploaded_;
317        size_type total_downloaded_;
318        size_type total_payload_downloaded_;
319       
320        size_type peers_;
321        size_type connected_peers_;
322        size_type seeds_;
323        size_type connected_seeds_;
324       
325        float ratio_;
326       
327        boost::posix_time::time_duration estimated_time_left_;
328        boost::posix_time::time_duration update_tracker_in_;
329       
330        boost::posix_time::time_duration active_;
331        boost::posix_time::time_duration seeding_;
332        boost::posix_time::ptime start_time_;
333        boost::posix_time::ptime finish_time_;
334
335        int queue_position_;
336        bool managed_;
337       
338private:
339        mutable bool peer_details_filled_;
340        mutable peer_details_vec peer_details_;
341       
342        mutable bool file_details_filled_;
343        mutable file_details_vec file_details_;
344};
345
346typedef boost::shared_ptr<torrent_details> torrent_details_ptr;
347typedef boost::scoped_ptr<torrent_details> torrent_details_sptr;
348typedef boost::weak_ptr<torrent_details> torrent_details_wptr;
349typedef std::vector<torrent_details_ptr> torrent_details_vec;
350typedef std::map<std::wstring, torrent_details_ptr> torrent_details_map;
351
352class torrent_details_manager
353{
354public: 
355        void sort(size_t index, bool cmp_less = true) const;
356       
357        const torrent_details_vec torrents() const 
358        {
359                mutex_t::scoped_lock l(mutex_); 
360                return torrents_; 
361        }
362       
363        const torrent_details_vec selectedTorrents() const 
364        { 
365                mutex_t::scoped_lock l(mutex_); 
366                return selectedTorrents_; 
367        }
368       
369        const torrent_details_ptr focusedTorrent() const 
370        {
371                mutex_t::scoped_lock l(mutex_); 
372                return selectedTorrent_; 
373        }
374       
375        const torrent_details_ptr get(std::wstring filename) const
376        {
377                mutex_t::scoped_lock l(mutex_); 
378               
379                torrent_details_map::const_iterator i = torrentMap_.find(filename);
380               
381                if (i != torrentMap_.end())
382                        return i->second;
383                else
384                        return torrent_details_ptr();
385        }
386       
387        friend class bit;
388
389private:
390        void clearAll(const mutex_t::scoped_lock&)
391        {
392                // !! No mutex lock, it should only be called from functions which
393                // have the lock themselves, hence the unused function param
394               
395                torrents_.clear();
396                torrentMap_.clear();
397                selectedTorrents_.clear();
398                selectedTorrent_.reset();
399        }
400
401        mutable torrent_details_vec torrents_;
402       
403        torrent_details_map torrentMap_;
404        torrent_details_vec selectedTorrents_;
405        torrent_details_ptr selectedTorrent_;
406       
407        mutable mutex_t mutex_;
408};
409
410struct tracker_detail
411{
412        tracker_detail() {}
413        tracker_detail(std::wstring u, int t) : url(u), tier(t) {}
414       
415        bool operator<(const tracker_detail& t) const
416        {
417                return (tier < t.tier);
418        }
419       
420        std::wstring url;
421        int tier;
422};
423
424typedef std::vector<tracker_detail> tracker_details_t;
425
426struct web_seed_or_dht_node_detail
427{
428        web_seed_or_dht_node_detail();
429        web_seed_or_dht_node_detail(std::wstring u);
430        web_seed_or_dht_node_detail(std::wstring u, int p);
431               
432        std::wstring url;
433        int port;
434        std::wstring type;
435};
436
437typedef std::vector<pair<fs::wpath, size_type> > file_size_pairs_t;
438
439struct dht_node_detail
440{
441        dht_node_detail() {}
442        dht_node_detail(std::wstring u, int p) : url(u), port(p) {}
443       
444        std::wstring url;
445        int port;
446};
447
448typedef std::vector<dht_node_detail> dht_node_details_t;
449
450struct web_seed_detail
451{
452        web_seed_detail() {}
453        web_seed_detail(std::wstring u) : url(u) {}
454       
455        std::wstring url;
456};
457
458typedef std::vector<web_seed_detail> web_seed_details_t;
459
460struct create_torrent_params
461{
462        create_torrent_params() {}
463
464        std::wstring creator;
465        std::wstring comment;
466        int piece_size;
467        bool private_torrent;
468
469        file_size_pairs_t file_size_pairs;
470        fs::wpath root_path;
471
472        tracker_details_t trackers;
473        dht_node_details_t dht_nodes;
474        web_seed_details_t web_seeds;
475};
476
477class EventDetail;
478
479struct SessionDetail
480{
481        int port;
482       
483        std::pair<double, double> speed;
484       
485        bool dht_on;
486        size_t dht_nodes;
487        size_t dht_torrents;
488       
489        bool ip_filter_on;
490        size_t ip_ranges_filtered;
491};
492
493typedef boost::function<bool (size_t, size_t, size_t)> filterCallback;
494typedef boost::function<bool (size_t, std::wstring)> progress_callback;
495typedef boost::function<void (int)> report_num_active;
496typedef std::pair<wstring, wstring> wstring_pair;
497typedef std::pair<float, float> float_pair;
498typedef std::pair<int, int> int_pair;
499typedef std::pair<std::vector<int>, int> vec_int_pair;
500
501class bit_impl;
502class torrent_internal;
503
504class bit
505{
506public:         
507
508        enum mappings
509        {
510                mappingNone = 0,
511                mappingUPnP,
512                mappingNatPMP
513        };
514
515        enum allocations
516        {
517                sparse_allocation = 1,
518                compact_allocation,
519                full_allocation
520        };
521
522        enum queue_adjustments
523        {
524                move_up = 0,
525                move_down,
526                move_to_top,
527                move_to_bottom
528        };
529
530        class null_torrent : public std::exception
531        {
532        public:
533                null_torrent() {}               
534                virtual ~null_torrent() throw () {}
535        };
536
537        class torrent : public stlsoft::operator_bool_adaptor<torrent>
538        {
539                typedef torrent class_type;
540
541        public:
542                class exec_around_ptr
543                {
544                public:
545                        class proxy 
546                        {
547                        public:
548                                explicit proxy(torrent_internal* t);
549
550                                torrent_internal* operator->() 
551                                {
552                                        return t_;
553                                }
554
555                                ~proxy ();
556
557                        private:
558                                torrent_internal* t_;
559                                mutex_t::scoped_lock l_;
560                        };
561
562                        exec_around_ptr() {}
563                        exec_around_ptr(boost::shared_ptr<torrent_internal> p) : ptr(p) {}
564
565                        proxy operator->() const
566                        {
567                                if (!ptr)
568                                        throw null_torrent();
569
570                                return proxy(&(*ptr));
571                        }
572
573                        operator bool() const { return ptr; }
574
575                private:
576                        boost::shared_ptr<torrent_internal> ptr;
577                };
578
579                torrent();
580                torrent(boost::shared_ptr<torrent_internal> p);
581
582                const std::wstring get_name() const;
583
584                float get_ratio() const;
585                void set_ratio(float new_ratio);
586               
587                std::pair<int, int> get_connection_limits() const;
588                void set_connection_limits(const std::pair<int, int>&);
589                std::pair<float, float> get_rate_limits() const;
590                void set_rate_limits(const std::pair<float, float>&);
591
592                wpath get_save_directory() const;
593                void set_save_directory(const wpath&);
594                wpath get_move_to_directory() const;
595                void set_move_to_directory(const wpath&);
596
597                std::pair<wstring, wstring> get_tracker_login() const;
598                void set_tracker_login(const std::pair<wstring, wstring>&);
599
600                std::vector<tracker_detail> get_trackers() const;
601                void set_trackers(const std::vector<tracker_detail>&);
602
603                bool get_is_active() const;
604                bool get_in_session() const;
605
606                void set_file_priorities(const vec_int_pair&);
607
608                void set_managed(bool);
609                bool get_managed() const;
610
611        public:
612                STLSOFT_METHOD_PROPERTY_GET_EXTERNAL(const std::wstring, class_type, 
613                        get_name, name);
614
615                STLSOFT_METHOD_PROPERTY_GETSET_EXTERNAL(float, float, class_type, 
616                        get_ratio, set_ratio, ratio);
617
618                STLSOFT_METHOD_PROPERTY_GETSET_EXTERNAL(int_pair, const int_pair&, class_type, 
619                        get_connection_limits, set_connection_limits, connection_limits);
620                STLSOFT_METHOD_PROPERTY_GETSET_EXTERNAL(float_pair, const float_pair&, class_type, 
621                        get_rate_limits, set_rate_limits, rate_limits);
622               
623                STLSOFT_METHOD_PROPERTY_GETSET_EXTERNAL(wpath, const wpath&, class_type, 
624                        get_save_directory, set_save_directory, save_directory);
625                STLSOFT_METHOD_PROPERTY_GETSET_EXTERNAL(wpath, const wpath&, class_type, 
626                        get_move_to_directory, set_move_to_directory, move_to_directory);
627
628                STLSOFT_METHOD_PROPERTY_GETSET_EXTERNAL(wstring_pair, const wstring_pair&, 
629                        class_type, get_tracker_login, set_tracker_login, tracker_login);
630
631                STLSOFT_METHOD_PROPERTY_GET_EXTERNAL(bool, class_type, 
632                        get_is_active, is_active);
633                STLSOFT_METHOD_PROPERTY_GET_EXTERNAL(bool, class_type, 
634                        get_in_session, in_session);
635
636                STLSOFT_METHOD_PROPERTY_GETSET_EXTERNAL(std::vector<tracker_detail>, const std::vector<tracker_detail>&, 
637                        class_type, get_trackers, set_trackers, trackers);
638
639                STLSOFT_METHOD_PROPERTY_GETSET_EXTERNAL(bool, bool, class_type, 
640                        get_managed, set_managed, managed);
641
642                STLSOFT_METHOD_PROPERTY_SET_EXTERNAL(const vec_int_pair&, class_type, 
643                        set_file_priorities, file_priorities);
644
645                void reset_trackers();
646                bool is_open() const;
647                void adjust_queue_position(bit::queue_adjustments adjust);
648
649        private:
650                exec_around_ptr ptr;
651        };
652
653        void shutdown_session();
654        void save_torrent_data();
655
656        bool create_torrent(const create_torrent_params& params, fs::wpath out_file, progress_callback fn);
657
658        template<typename T>
659        torrent get(T t)
660        {
661                return get_wstr(to_wstr_shim(t));
662        }
663       
664        template<>
665        torrent get(const hal::torrent_details_ptr t)
666        {
667                if (t) 
668                        return get_wstr(t->name());
669                else
670                        return torrent();
671        }       
672
673        torrent get_wstr(const std::wstring& filename);
674       
675        bool listen_on(std::pair<int, int> const& portRange);
676        int is_listening_on();
677        void stop_listening();
678       
679        bool ensure_dht_on(const dht_settings& dht);
680        void ensure_dht_off();
681       
682        void ensure_pe_on(const pe_settings& pe);
683        void ensure_pe_off();
684       
685        bool ensure_ip_filter_on(progress_callback fn);
686        void ensure_ip_filter_off();
687
688        void set_resolve_countries(bool);
689        void start_smart_ban_plugin();
690        void start_ut_pex_plugin();
691        void start_ut_metadata_plugin();
692        void start_metadata_plugin();
693
694        void set_mapping(bool upnp, bool nat_pmp);
695        std::wstring upnp_router_model();
696
697        void ip_v4_filter_block(boost::asio::ip::address_v4 first, boost::asio::ip::address_v4 last);
698        void ip_v6_filter_block(boost::asio::ip::address_v6 first, boost::asio::ip::address_v6 last);
699        bool ip_filter_import_dat(boost::filesystem::path file, progress_callback fn, bool octalFix);
700        size_t ip_filter_size();
701        void clear_ip_filter(); 
702       
703        void set_session_half_open_limit(int halfConn);
704        void set_session_limits(int maxConn, int maxUpload);
705        void set_session_speed(float download, float upload);
706
707        queue_settings get_queue_settings();
708        void set_queue_settings(const queue_settings& s);
709       
710        timeouts get_timeouts();
711        void set_timeouts(const timeouts& t);
712
713        const cache_details get_cache_details() const;
714
715        void set_cache_settings(const cache_settings& cache);
716        cache_settings get_cache_settings() const;
717       
718        const SessionDetail get_session_details();
719
720        void set_torrent_defaults(const connections& defaults); 
721        void add_torrent(boost::filesystem::wpath file, boost::filesystem::wpath saveDirectory, 
722                bool startPaused=false, bool managed=false, allocations alloc=hal::bit::sparse_allocation, 
723                boost::filesystem::wpath moveToDirectory=L"", bool useMoveTo=false);
724       
725        void get_all_peer_details(const std::string& filename, peer_details_vec& peerContainer);
726        void get_all_peer_details(const std::wstring& filename, peer_details_vec& peerContainer);
727        void get_all_file_details(const std::string& filename, file_details_vec& file_details);
728        void get_all_file_details(const std::wstring& filename, file_details_vec& file_details);
729       
730        void resume_all();
731        void close_all(boost::optional<report_num_active> fn);
732       
733        bool is_torrent(const std::string& filename);
734        bool is_torrent(const std::wstring& filename); 
735       
736        void pause_torrent(const std::string& filename);
737        void pause_torrent(const std::wstring& filename);
738        void resume_torrent(const std::string& filename);
739        void resume_torrent(const std::wstring& filename);
740        void stop_torrent(const std::string& filename);
741        void stop_torrent(const std::wstring& filename);
742        bool is_torrent_active(const std::string& filename);
743        bool is_torrent_active(const std::wstring& filename);
744        void reannounce_torrent(const std::string& filename);
745        void reannounce_torrent(const std::wstring& filename);
746        void recheck_torrent(const std::string& filename);
747        void recheck_torrent(const std::wstring& filename);
748       
749        void pause_all_torrents();
750        void unpause_all_torrents();
751
752        template<typename S>
753        void remove_torrent(S filename)
754        { 
755                remove_torrent_wstr(to_wstr_shim(filename)); 
756        }       
757
758        template<typename S>
759        void remove_torrent_wipe_files(S filename)
760        { 
761                remove_torrent_wipe_files_wstr(to_wstr_shim(filename)); 
762        }       
763
764        void start_event_receiver();
765        void stop_event_receiver();
766       
767        friend bit& bittorrent();
768       
769        int default_torrent_max_connections();
770        int default_torrent_max_uploads();
771        float default_torrent_download();
772        float default_torrent_upload(); 
773
774        const torrent_details_manager& torrentDetails();
775        const torrent_details_manager& updatetorrent_details_manager(const std::wstring& focused, const std::set<std::wstring>& selected);
776       
777private:
778        bit();
779
780        bit_impl* pimpl();
781        const bit_impl* pimpl() const;
782        boost::scoped_ptr<bit_impl> pimpl_;
783       
784        void remove_torrent_wstr(const std::wstring& filename);
785        void remove_torrent_wipe_files_wstr(const std::wstring&  filename);
786       
787        torrent_details_manager torrentDetails_;
788};
789
790bit& bittorrent();
791
792};
Note: See TracBrowser for help on using the repository browser.