1 //////////////////////////////////////////////////////////////////////////////
2 //
3 // Copyright (c) 2004-2021 musikcube team
4 //
5 // All rights reserved.
6 //
7 // Redistribution and use in source and binary forms, with or without
8 // modification, are permitted provided that the following conditions are met:
9 //
10 //    * Redistributions of source code must retain the above copyright notice,
11 //      this list of conditions and the following disclaimer.
12 //
13 //    * Redistributions in binary form must reproduce the above copyright
14 //      notice, this list of conditions and the following disclaimer in the
15 //      documentation and/or other materials provided with the distribution.
16 //
17 //    * Neither the name of the author nor the names of other contributors may
18 //      be used to endorse or promote products derived from this software
19 //      without specific prior written permission.
20 //
21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 // ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
25 // LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26 // CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27 // SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28 // INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29 // CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30 // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31 // POSSIBILITY OF SUCH DAMAGE.
32 //
33 //////////////////////////////////////////////////////////////////////////////
34 
35 #pragma once
36 
37 #include "constants.h"
38 #include "IIndexerWriter.h"
39 #include "ITagStore.h"
40 #include <string>
41 
42 namespace musik { namespace core { namespace sdk {
43 
44     class IIndexerSource {
45         public:
46             virtual void Release() = 0;
47 
48             virtual void OnBeforeScan() = 0;
49 
50             virtual void OnAfterScan() = 0;
51 
52             virtual ScanResult Scan(
53                 IIndexerWriter* indexer,
54                 const char** indexerPaths,
55                 unsigned indexerPathsCount) = 0;
56 
57             virtual void ScanTrack(
58                 IIndexerWriter* indexer,
59                 ITagStore* store,
60                 const char* externalId) = 0;
61 
62             virtual bool NeedsTrackScan() = 0;
63 
64             virtual void Interrupt() = 0;
65 
66             virtual bool HasStableIds() = 0;
67 
68             virtual int SourceId() = 0;
69     };
70 
71     namespace indexer {
72         template <typename String=std::string>
parseExternalId(const String & prefix,const String & externalId,String & fn,int & track)73         static bool parseExternalId(const String& prefix, const String& externalId, String& fn, int& track) {
74             if (externalId.find(String(prefix + "://")) == 0) {
75                 String trimmed = externalId.substr(prefix.size() + 3);
76                 auto slash = trimmed.find("/");
77                 if (slash != String::npos) {
78                     try {
79                         track = std::stoi(trimmed.substr(0, slash));
80                         fn = trimmed.substr(slash + 1);
81                         return true;
82                     }
83                     catch (...) {
84                         return false;
85                     }
86                 }
87             }
88             return false;
89         }
90 
91         template <typename String=std::string>
createExternalId(const String & prefix,const String & fn,int track)92         static inline String createExternalId(const String& prefix, const String& fn, int track) {
93             return prefix + "://" + std::to_string(track) + "/" + fn;
94         }
95 
96         template <typename String=std::string>
externalIdExists(const String & externalId)97         static inline bool externalIdExists(const String& externalId) {
98             String fn;
99             int trackNum;
100             if (!parseExternalId(externalId, fn, trackNum)) {
101                 return false;
102             }
103             return fileExists(fn);
104         }
105     }
106 
107 } } }
108