File: arg_parse_version_check.h

package info (click to toggle)
seqan2 2.3.1%2Bdfsg-4~bpo8%2B1
  • links: PTS, VCS
  • area: main
  • in suites: jessie-backports
  • size: 222,312 kB
  • sloc: cpp: 252,894; ansic: 86,805; python: 6,534; sh: 985; xml: 570; makefile: 236; awk: 51
file content (474 lines) | stat: -rw-r--r-- 17,809 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
// ==========================================================================
//                 SeqAn - The Library for Sequence Analysis
// ==========================================================================
// Copyright (c) 2006-2016, Knut Reinert, FU Berlin
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
//     * Redistributions of source code must retain the above copyright
//       notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above copyright
//       notice, this list of conditions and the following disclaimer in the
//       documentation and/or other materials provided with the distribution.
//     * Neither the name of Knut Reinert or the FU Berlin nor the names of
//       its contributors may be used to endorse or promote products derived
//       from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL KNUT REINERT OR THE FU BERLIN BE LIABLE
// FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
// DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
// CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
// LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
// OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
// DAMAGE.
//
// ==========================================================================
// Author: Svenja Mehringer <svenja.mehringer@fu-berlin.de>
// ==========================================================================

#ifndef SEQAN_INCLUDE_ARG_PARSE_VERSION_CHECK_H_
#define SEQAN_INCLUDE_ARG_PARSE_VERSION_CHECK_H_

#include <sys/stat.h>

#include <iostream>
#include <fstream>
#include <regex>
#include <future>
#include <chrono>

namespace seqan
{

// ==========================================================================
// Forwards
// ==========================================================================

// NOTE(rrahn): In-file forward for function call operator.
struct VersionCheck;
inline void _checkForNewerVersion(VersionCheck &, std::promise<bool>);
inline std::string _getPath();
constexpr const char * _getOS();
constexpr const char * _getBitSys();

// ==========================================================================
// Tags, Classes, Enums
// ==========================================================================

template <typename TVoidSpec = void>
struct VersionControlTags_
{
    static constexpr char const * const SEQAN_NAME         = "seqan";
    static constexpr char const * const UNREGISTERED_APP   = "UNREGISTERED_APP";

    static constexpr char const * const MESSAGE_SEQAN_UPDATE =
        "[SEQAN INFO] :: There is a newer SeqAn version available!\n"
        "[SEQAN INFO] :: Please visit www.seqan.de for an update or inform the developer of this app.\n"
        "[SEQAN INFO] :: If you don't want to receive this message again set --version-check OFF\n\n";
    static constexpr char const * const MESSAGE_APP_UPDATE =
        "[APP INFO] :: There is a newer version of this application available.\n"
        "[APP INFO] :: If this app is developed by SeqAn, visit www.seqan.de for updates.\n"
        "[APP INFO] :: If you don't want to receive this message again set --version_check OFF\n\n";
    static constexpr char const * const MESSAGE_UNREGISTERED_APP =
        "[SEQAN INFO] :: Thank you for using SeqAn!\n"
        "[SEQAN INFO] :: You might want to regsiter you app for support and version check features?\n"
        "[SEQAN INFO] :: Just send us an email to seqan@team.fu-berlin.de with your app name and version number.\n"
        "[SEQAN INFO] :: If you don't want to receive this message anymore set --version_check OFF\n\n";
    static constexpr char const * const MESSAGE_REGISTERED_APP_UPDATE =
        "[APP INFO] :: We noticed the app version you use is newer than the one registered with us.\n"
        "[APP INFO] :: Please send us an email with the new version so we can correct it (support@seqan.de)\n\n";
};

template <typename TVoidSpec>
constexpr char const * const VersionControlTags_<TVoidSpec>::SEQAN_NAME;
template <typename TVoidSpec>
constexpr char const * const VersionControlTags_<TVoidSpec>::UNREGISTERED_APP;
template <typename TVoidSpec>
constexpr char const * const VersionControlTags_<TVoidSpec>::MESSAGE_SEQAN_UPDATE;
template <typename TVoidSpec>
constexpr char const * const VersionControlTags_<TVoidSpec>::MESSAGE_APP_UPDATE;
template <typename TVoidSpec>
constexpr char const * const VersionControlTags_<TVoidSpec>::MESSAGE_UNREGISTERED_APP;
template <typename TVoidSpec>
constexpr char const * const VersionControlTags_<TVoidSpec>::MESSAGE_REGISTERED_APP_UPDATE;

struct VersionCheck
{
    // ----------------------------------------------------------------------------
    // Member Variables
    // ----------------------------------------------------------------------------
    std::string _url;
    std::string _name;
    std::string _version = "0.0.0";
    std::string _program;
    std::string _command;
    std::string _path = _getPath();
    std::ostream & errorStream;

    // ----------------------------------------------------------------------------
    // Constructors
    // ----------------------------------------------------------------------------

    VersionCheck(std::string name,
                 std::string const & version,
                 std::ostream & errorStream) :
        _name{std::move(name)},
        errorStream(errorStream)
    {
        std::smatch versionMatch;
        if (!version.empty() &&
            std::regex_search(version, versionMatch, std::regex("^([[:digit:]]+\\.[[:digit:]]+\\.[[:digit:]]+).*")))
        {
            _version = versionMatch.str(1); // in case the git revision number is given take only version number
        }
        _url = static_cast<std::string>("http://seqan-update.informatik.uni-tuebingen.de/check/SeqAn_") + _getOS() + _getBitSys() + _name + "_" + _version;
        _getProgram();
        _updateCommand();
    }

    // ----------------------------------------------------------------------------
    // Member Functions
    // ----------------------------------------------------------------------------

#if defined(STDLIB_VS)
    void _getProgram()
    {
        _program = "powershell.exe -NoLogo -NonInteractive -Command \"& {Invoke-WebRequest -erroraction 'silentlycontinue' -OutFile";
    }
#else  // Unix based platforms.
    void _getProgram()
    {
        // ask if system call for version or help is successfull
        if (!system("wget --version > /dev/null 2>&1"))
            _program = "wget -q -O";
        else if (!system("curl --version > /dev/null 2>&1"))
            _program =  "curl -o";
#ifndef __linux  // ftp call does not work on linux
        else if (!system("which ftp > /dev/null 2>&1"))
            _program =  "ftp -Vo";
#endif
        else
            _program.clear();
    }
#endif  // defined(STDLIB_VS)

    void _updateCommand()
    {
        if (!_program.empty())
        {
            _command = _program + " " + _path + "/" + _name + ".version " + _url;
#if defined(STDLIB_VS)
            _command = _command + "; exit  [int] -not $?}\" > nul 2>&1";
#else
            _command = _command + " > /dev/null 2>&1";
#endif
        }
    }

    inline void operator()(std::promise<bool> versionCheckProm)
    {
        _checkForNewerVersion(*this, std::move(versionCheckProm));
    }
};

// ==========================================================================
// Metafunctions
// ==========================================================================

// ==========================================================================
// Functions
// ==========================================================================

// ----------------------------------------------------------------------------
// Function setURL()
// ----------------------------------------------------------------------------

inline void setURL(VersionCheck & me, std::string url)
{
    std::swap(me._url, url);
    me._updateCommand();
}

// ----------------------------------------------------------------------------
// Function _getOS()
// ----------------------------------------------------------------------------

constexpr const char * _getOS()
{
    //get system information
#ifdef __linux
    return "Linux";
#elif __APPLE__
    return "MacOS";
#elif defined(STDLIB_VS)
    return "Windows";
#elif __FreeBSD__
    return "FreeBSD";
#elif __OpenBSD__
    return "OpenBSD";
#else
    return "unknown";
#endif
}

// ----------------------------------------------------------------------------
// Function _getBitSys()
// ----------------------------------------------------------------------------

constexpr const char * _getBitSys()
{
#if SEQAN_IS_32_BIT
    return "_32_";
#else
     return "_64_";
#endif
}

// ----------------------------------------------------------------------------
// Function _checkWritability()
// ----------------------------------------------------------------------------

#if defined(STDLIB_VS)
inline bool _checkWritability(std::string const & path)
{
    DWORD ftyp = GetFileAttributesA(path.c_str());
    if (ftyp == INVALID_FILE_ATTRIBUTES || !(ftyp & FILE_ATTRIBUTE_DIRECTORY))
    {
        if (!CreateDirectory(path.c_str(), NULL))
            return false;
    }

    HANDLE dummyFile; // check writablity by trying to create a file in GENERIC_WRITE mode
    std::string fileName(path + "/dummy.txt");
    dummyFile = CreateFile(fileName.c_str(), GENERIC_WRITE, 0, NULL, CREATE_ALWAYS, FILE_ATTRIBUTE_NORMAL, NULL);

    if (dummyFile == INVALID_HANDLE_VALUE)
        return false;

    CloseHandle(dummyFile);
    bool successful_deletion = DeleteFile(fileName.c_str());
    SEQAN_ASSERT(successful_deletion);
    if (!successful_deletion)
        return false;

    return true;
}
#else
inline bool _checkWritability(std::string const & path)
{
    struct stat d_stat;
    if (stat(path.c_str(), &d_stat) < 0)
    {
        // try to make dir
        std::string makeDir("mkdir -p " + path);
        if (system(makeDir.c_str()))
            return false; // could not create home dir

        if (stat(path.c_str(), &d_stat) < 0) // repeat stat
            return false;
    }

    if (!(d_stat.st_mode & S_IWUSR))
        return false; // dir not writable

    return true;
}
#endif

// ----------------------------------------------------------------------------
// Function _getPath()
// ----------------------------------------------------------------------------

inline std::string _getPath()
{
    std::string path;
#if defined(STDLIB_VS)
    path = std::string(getenv("UserProfile")) + "/.config/seqan";
#else
    path = std::string(getenv("HOME")) + "/.config/seqan";
#endif

    // check if user has permission to write to home path
    if (!_checkWritability(path))
    {
#if defined(STDLIB_VS)
        TCHAR tmp_path [MAX_PATH];
        if (GetTempPath(MAX_PATH, tmp_path) != 0)
        {
            path = tmp_path;
        }
        else
        { //GetTempPath() returns 0 on failure
            path.clear();
        }
# else // unix
        path = "/tmp";
#endif
    }
    return path;
}

// ----------------------------------------------------------------------------
// Function _getFileTimeDiff()
// ----------------------------------------------------------------------------

inline double _getFileTimeDiff(std::string const & timestamp_filename)
{
    double curr = static_cast<double>(std::chrono::duration_cast<std::chrono::seconds>(std::chrono::system_clock::now().time_since_epoch()).count());
    std::ifstream timestamp_file;
    timestamp_file.open(timestamp_filename.c_str());

    if (timestamp_file.is_open())
    {
        std::string str_time;
        std::getline(timestamp_file, str_time);
        timestamp_file.close();
        double d_time;
        lexicalCast(d_time, str_time);
        return curr - d_time;
    }
    return curr;
}

// ----------------------------------------------------------------------------
// Function _getNumbersFromString()
// ----------------------------------------------------------------------------

inline String<int> _getNumbersFromString(std::string const & str)
{
    String<int> numbers;
    StringSet<std::string> set;
    strSplit(set, str, EqualsChar<'.'>(), false);
    for (auto & num : set)
    {
        appendValue(numbers, lexicalCast<int>(num));
    }
    return numbers;
}

// ----------------------------------------------------------------------------
// Function _readVersionString()
// ----------------------------------------------------------------------------

inline void _readVersionStrings(std::vector<std::string> & versions, std::string const & version_file)
{
    std::ifstream myfile;
    myfile.open(version_file.c_str());
    std::string app_version;
    std::string seqan_version;
    if (myfile.is_open())
    {
        std::getline(myfile, app_version); // get first line which should only contain the version number of the app

#if !defined(NDEBUG) || defined(SEQAN_TEST_VERSION_CHECK_)
        if (app_version == VersionControlTags_<>::UNREGISTERED_APP)
            versions[0] = app_version;
#endif // !defined(NDEBUG) || defined(SEQAN_TEST_VERSION_CHECK_)

        if (std::regex_match(app_version, std::regex("^[[:digit:]]+\\.[[:digit:]]+\\.[[:digit:]]+$")))
            versions[0] = app_version;

        std::getline(myfile, seqan_version); // get second line which should only contain the version number of seqan

        if (std::regex_match(seqan_version, std::regex("^[[:digit:]]+\\.[[:digit:]]+\\.[[:digit:]]+$")))
            versions[1] = seqan_version;

        myfile.close();
    }
}

// ----------------------------------------------------------------------------
// Function _callServer()
// ----------------------------------------------------------------------------

inline void _callServer(VersionCheck const me, std::promise<bool> prom)
{
    // update timestamp
    std::string timestamp_filename(me._path + "/" + me._name + ".timestamp");
    std::ofstream timestamp_file(timestamp_filename.c_str());
    if (timestamp_file.is_open())
    {
        timestamp_file << std::chrono::duration_cast<std::chrono::seconds>(std::chrono::system_clock::now().time_since_epoch()).count();
        timestamp_file.close();
    }

    // system call
    // http response is stored in a file '.config/seqan/{app_name}_version'
    if (system(me._command.c_str()))
        prom.set_value(false);
    else
        prom.set_value(true);
}

// ----------------------------------------------------------------------------
// Function checkForNewerVersion()
// ----------------------------------------------------------------------------

inline void _checkForNewerVersion(VersionCheck & me, std::promise<bool> prom)
{
    if (me._path.empty()) // neither home dir nor temp dir are writable
    {
        prom.set_value(false);
        return;
    }

    std::string version_filename(me._path + "/" + me._name + ".version");
    std::string timestamp_filename(me._path + "/" + me._name + ".timestamp");
    double min_time_diff(86400);                                 // one day = 86400 seonds
    double file_time_diff(_getFileTimeDiff(timestamp_filename)); // time difference in seconds

    if (file_time_diff < min_time_diff)
    {
        prom.set_value(false); // only check for newer version once a day
        return;
    }

    std::vector<std::string> str_server_versions{"", ""};
    _readVersionStrings(str_server_versions, version_filename);

#if !defined(NDEBUG) || defined(SEQAN_TEST_VERSION_CHECK_) // only check seqan version in debug or testing mode
    if (!str_server_versions[1].empty()) // seqan version
    {
        std::string seqan_version = std::to_string(SEQAN_VERSION_MAJOR) + "." +
                                    std::to_string(SEQAN_VERSION_MINOR) + "." +
                                    std::to_string(SEQAN_VERSION_PATCH);
        Lexical<> version_comp(_getNumbersFromString(seqan_version), _getNumbersFromString(str_server_versions[1]));

        if (isLess(version_comp))
            me.errorStream << VersionControlTags_<>::MESSAGE_SEQAN_UPDATE;
    }
    if (str_server_versions[0] == VersionControlTags_<>::UNREGISTERED_APP)
        me.errorStream << VersionControlTags_<>::MESSAGE_UNREGISTERED_APP;
#endif

#if defined(NDEBUG) || defined(SEQAN_TEST_VERSION_CHECK_) // only check app version in release or testing mode
    if (!str_server_versions[0].empty() & !(str_server_versions[0] == VersionControlTags_<>::UNREGISTERED_APP)) // app version
    {
        Lexical<> version_comp(_getNumbersFromString(me._version), _getNumbersFromString(str_server_versions[0]));

        if (isLess(version_comp))
            me.errorStream << VersionControlTags_<>::MESSAGE_APP_UPDATE;

        else if (isGreater(version_comp))
            me.errorStream << VersionControlTags_<>::MESSAGE_REGISTERED_APP_UPDATE;
    }
#endif // defined(NDEBUG) || defined(SEQAN_TEST_VERSION_CHECK_)

    if (me._program.empty())
    {
        prom.set_value(false);
        return;
    }

    // launch a seperate thread to not defer runtime.
    std::thread(_callServer, me, std::move(prom)).detach();
}

} // namespace seqan
#endif //SEQAN_INCLUDE_ARG_PARSE_VERSION_CHECK_H_