1 /* ===========================================================================
2  *
3  *                            PUBLIC DOMAIN NOTICE
4  *               National Center for Biotechnology Information
5  *
6  *  This software/database is a "United States Government Work" under the
7  *  terms of the United States Copyright Act.  It was written as part of
8  *  the author's official duties as a United States Government employee and
9  *  thus cannot be copyrighted.  This software/database is freely available
10  *  to the public for use. The National Library of Medicine and the U.S.
11  *  Government have not placed any restriction on its use or reproduction.
12  *
13  *  Although all reasonable efforts have been taken to ensure the accuracy
14  *  and reliability of the software and data, the NLM and the U.S.
15  *  Government do not and cannot warrant the performance or results that
16  *  may be obtained by using this software or data. The NLM and the U.S.
17  *  Government disclaim all warranties, express or implied, including
18  *  warranties of performance, merchantability or fitness for any particular
19  *  purpose.
20  *
21  *  Please cite the author in any work or product based on this material.
22  *
23  * ===========================================================================
24  *
25  * Project:
26  *  sratools command line tool
27  *
28  * Purpose:
29  *  Define environment variable names (shared with library)
30  *
31  */
32 
33 /* Tool Session ID */
34 /*   Also defined in ncbi-vdb/libs/kns/manager.c */
35 #define ENV_VAR_SESSION_ID "VDB_SESSION_ID"
36 
37 /* Compute Environment Token (aka CE Token) */
38 /*   Also defined in ncbi-vdb/interfaces/klib/strings.h */
39 #define ENV_VAR_CE_TOKEN "VDB_CE_TOKEN"
40 
41 
42 /* MARK: .sra file */
43 
44 /* Remote location of .sra file */
45 #define ENV_VAR_REMOTE_URL ENV_MAGIC_REMOTE
46 
47 /* Local path of .sra file */
48 #define ENV_VAR_LOCAL_URL ENV_MAGIC_LOCAL
49 
50 /* Local path for caching .sra file */
51 #define ENV_VAR_CACHE_URL ENV_MAGIC_CACHE
52 
53 /* Size of .sra file */
54 #define ENV_VAR_SIZE_URL "VDB_SIZE_URL"
55 
56 /* CE Token is required for .sra file if set to '1' */
57 #define ENV_VAR_REMOTE_NEED_CE "VDB_REMOTE_NEED_CE"
58 
59 /* Payment is required for remote .sra file if set to '1' */
60 #define ENV_VAR_REMOTE_NEED_PMT "VDB_REMOTE_NEED_PMT"
61 
62 
63 /* MARK: .vdbcache file */
64 /* INFO: These are set ONLY if there is .vdbcache file */
65 
66 /* Remote location of .vdbcache file */
67 #define ENV_VAR_REMOTE_VDBCACHE ENV_MAGIC_REMOTE_VDBCACHE
68 
69 /* Local path of .vdbcache file */
70 #define ENV_VAR_LOCAL_VDBCACHE ENV_MAGIC_LOCAL_VDBCACHE
71 
72 /* Local path for caching .vdbcache file */
73 #define ENV_VAR_CACHE_VDBCACHE ENV_MAGIC_CACHE_VDBCACHE
74 
75 /* Size of .vdbcache file */
76 #define ENV_VAR_SIZE_VDBCACHE "VDB_SIZE_VDBCACHE"
77 
78 /* CE Token is required for remote .vdbcache file if set to '1' */
79 #define ENV_VAR_CACHE_NEED_CE "VDB_CACHE_NEED_CE"
80 
81 /* Payment is required for remote .vdbcache file if set to '1' */
82 #define ENV_VAR_CACHE_NEED_PMT "VDB_CACHE_NEED_PMT"
83