aboutsummaryrefslogtreecommitdiffstats
path: root/scripts/usr/bin/drive-list-shared
blob: 92e982c19d4ed8f897a32109e656a5bd89b815ed (about) (plain)
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
#!/bin/bash
###################################################################################################
# drive-list-shared
###################################################################################################
# Copyright 2017-2022 Jean-Christophe Manciot <jcmanciot@sdxlive.com>
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except 
# in compliance with the License. You may obtain a copy of the License at:
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# This script is using a project hosted at https://github.com/odeke-em/drive, originally developed 
# by Burcu Dogan while working on the Google Drive team and now maintained by Emmanuel T Odeke.
#
# Attribution — You must give appropriate credit, provide a link to the license, and indicate if 
#               changes were made. You may do so in any reasonable manner, but not in any way that 
#               suggests the licensor endorses you or your use.
###################################################################################################

###################################################################################################
#
# Listing recursively all shared files/folders (objects) from your Google Drive.online in the 
# current directory's remote equivalent.
# The scale of the operation depends on the depth setting in your <google_drive_folder>/.driverc.
# The list of objects affected by this operation can be optionnaly filtered by:
#       - <google_drive_folder>/.driveignore
#       - ./.driveselect
#
###################################################################################################
#
# Requirements:
# ------------
#
# - We assume that:
#       + drive-google package is already installed.
#       + coreutils, grep, perl-base, sed & zenity packages are already installed.
#
# - This command must be called from within your local Google drive folder(s).
#
# - <google_drive_folder>/.driverc:it must be properly setup, either manually or with drive-setup,
#                                  with the following settings:
#       * depth=
#               + -1: an infinite traversal depth, i.e recursive traversal from the current working  
#                     directory until there is no more child folder
#               + non-zero number: a fixed traversal depth
#       * ...: cf. https://github.com/odeke-em/drive for a complete list of available  
#              options. They can only be set manually through .driverc or through drive-setup for
#              the sake of simplicity.
#              Cf. /etc/drive-google/.driverc for some examples.
#
# - <google_drive_folder>/.driveignore: it may be used to exclude/include some objects from the 
#                                       scope of the current drive-<command> by using regular
#                                       expressions.
#                                       Cf. /etc/drive-google/.driveignore for its format & some 
#                                       examples.
#
# - ./.driveselect: it may be used to include/exclude the objects from the scope of the current 
#                   drive-<command>. 
#                   Cf. /etc/drive-google/.driveselect for its format & some examples.
#
###################################################################################################
#
# Parameters:
# ----------
#
# - <anything> will display this help message
#
###################################################################################################
#
# Usage examples:
# --------------
#
# cd ~/<google_drive_folder>/folder/you/need/to/list/with/its/children
# drive-list-shared
#
###################################################################################################
if [[ $LOG_DRIVE_LIST_SHARED == ON ]]; then
        # Getting the last existing file descriptor of ~/.drive-google/logs/drive-google.log
        fd=$(ls -al /proc/$$/fd | grep ~/.drive-google/logs/drive-google.log | sed -E 's|^.* ([0-9]+) -> .*$|\1|g' | sort -V | tail -n 1)

        # Case where fd is unset, i.e the file ~/.drive-google/logs/drive-google.log has not yet been opened
        if [[ -z $fd ]]; then
                lowest_unused_fd () 
                {
                        local fd=0
                        while [ -e /proc/$$/fd/${fd} ]; do
                                fd=$((fd+1))
                        done
                        echo $fd
                }
                fd=$(lowest_unused_fd)

                # Opening ~/.drive-google/logs/drive-google.log as file descriptor $fd for appending
                eval "exec $fd>> ~/.drive-google/logs/drive-google.log"
        fi

        # Writing the trace output generated when set -x is enabled to file descriptor $fd 
        eval "BASH_XTRACEFD=$fd"
        # Logging line numbers - We could also use ${0} for ${BASH_SOURCE}
        BASH_SOURCE_BASENAME=$(basename ${BASH_SOURCE})
        export PS4='${BASH_SOURCE_BASENAME}.${LINENO}+ '
        # Expanding all variables and prints the full commands before output of the command
        set -x
fi

# Preventing globbing (pathname expansion)
set -o noglob
# Allowing extended globbing
shopt -s extglob
# Expanding aliases
shopt -s expand_aliases

# Including alias definitions to sed/grep/awk/perl commands for readability sake
. /usr/include/drive-google/aliases

#------------------------------------list-shared-objects------------------------------------------------
# Listing shared objects among all objects listed in "${filtered_objects[@]}"
# Usage: list-shared-objects | zenity --progress --percentage=0 --auto-close
# Return strings which feed 'zenity --progress'
# - "# Checking $object"
# - "$current_percentage"
# The function uses the global array variables:
# - "${filtered_objects[@]}"
function list-shared-objects ()
{
        # Initializing:
        # - current checked objects number so far,
        # - current percentage of checked objects so far,
        # - current object stat information
        # - all shared objects information
        # - current index in the ${shared_objects_information[]} array
        # - current shared objects number so far
        current_objects_number=0
        current_percentage=0
        stat_information=()
        shared_objects_information=()
        shared_objects_information_index=0

        for object in "${filtered_objects[@]}"
        do
                # Getting the object type from its leading character
                object_type=$(echo "$object" | extract_object_type)

                # Removing leading object stats
                object=$(echo "$object" | rm_object_stats)

                # Feeding 'zenity --progress'
                LC_ALL=C printf '%s\n' "# Checking $object"

                # Removing all occurrences of '&' in $object as a workaround to a markup ampersand issue with zenity
                noamp_object=$(echo "${object}" | rm_ampersand)

                # While there is a connection error and the user wants to continue trying
                while :
                do
                        unset stat_information
                        unset shared_objects_information

                        # Getting shared information of $object
                        readarray -t stat_information < <(drive stat -depth 0 "$object" 2>&1)

                        if [[ "${stat_information[@]}" =~ 'Get https://www.googleapis.com/drive/' ]]; then
                                # Connection error
                                # Displaying the error 
                                zenity --error --title "Connection error accessing your Google Drive online in ${noamp_local_folder}" --text="${noamp_object}\n\nCould not connect to https://www.googleapis.com/drive/v2/files or/nor to https://accounts.google.com/o/oauth2/token" --width 1400
                                zenity --question --title "Connection error accessing your Google Drive online in ${noamp_local_folder}" --text="${noamp_object}\n\nDo you want to abort current drive operation?" --width 1400

                                if [[ $? -eq 1 ]]; then
                                        # Continuing trying
                                        continue
                                elif [[ $? -eq 0 ]]; then
                                        # Aborting
                                        exit 9
                                fi
                        elif [[ "${stat_information[@]}" =~ "doesn't exist" ]]; then
                                continue 2
                        fi

                        # Getting a field specific to some objects only, not all - incrementing UNSHARED_STAT_INFORMATION_LENGTH by 1
                        original_object_name=$(printf '%s\n' "${stat_information[@]}" | select_OriginalFilename)

                        if [[ $object_type == 'd' ]]; then
                                if [[ "$original_object_name" =~ OriginalFilename ]]; then
                                        # Number of lines returned by 'drive stat' when the folder is not shared
                                        UNSHARED_STAT_INFORMATION_LENGTH=27
                                else
                                        # Number of lines returned by 'drive stat' when the folder is not shared
                                        UNSHARED_STAT_INFORMATION_LENGTH=26
                                fi
                        elif [[ $object_type == '-' ]]; then
                                if [[ "$original_object_name" =~ OriginalFilename ]]; then
                                        # Number of lines returned by 'drive stat' when the object is not shared
                                        UNSHARED_STAT_INFORMATION_LENGTH=29
                                else
                                        # Number of lines returned by 'drive stat' when the object is not shared
                                        UNSHARED_STAT_INFORMATION_LENGTH=28
                                fi
                        else
                                # This is an unknown object type ?
                                shared_objects_information[$shared_objects_information_index]="--------------------------------------------"
                                (( shared_objects_information_index++ ))
                                shared_objects_information[$shared_objects_information_index]="$object"
                                (( shared_objects_information_index++ ))
                                shared_objects_information[$shared_objects_information_index]="Unknown object type"
                                (( shared_objects_information_index++ ))

                                # Moving on to the next object
                                break
                        fi

                        (( current_objects_number++ ))

                        # Computing the current percentage of pulled objects
                        current_percentage=$(echo "scale=4; (${current_objects_number}/${#filtered_objects[@]})*100" | bc)

                        # Feeding 'zenity --progress'
                        LC_ALL=C printf '%.2f\n' "$current_percentage"

                        shared=$(printf '%s\n' "${stat_information[@]}" | select_Shared | extract_shared)

                        if [[ $shared =~ false ]]; then
                                # This object has not been shared - let's go on with the next object
                                continue 2
                        fi

                        shared_objects_information[$shared_objects_information_index]="--------------------------------------------"
                        (( shared_objects_information_index++ ))
                        shared_objects_information[$shared_objects_information_index]="$object"
                        (( shared_objects_information_index++ ))

                        # For all lines containing sharing information
                        for ((stat_information_index=`expr $UNSHARED_STAT_INFORMATION_LENGTH + 1`; stat_information_index<${#stat_information[@]}; stat_information_index++))
                        do
                                shared_objects_information[$shared_objects_information_index]="${stat_information[${stat_information_index}]}"
                                (( shared_objects_information_index++ ))
                        done

                        # We're done
                        break
                done

                # Saving "${shared_objects_information[@]}" in temporary .driveoutput.log file after having escaped all "escape sequences"
                printf '%b\n' "${shared_objects_information[@]}" | escape_escape_sequences >> .driveoutput.log
        done
}

#------------------------------------drive-list-shared---------------------------------------------

# Checking for no parameter
if [[ $# -eq 0 ]]; then
        local_folder="$(pwd)"

        # Removing all occurrences of '&' in $object as a workaround to a markup ampersand issue with zenity
        noamp_local_folder="$(echo "${local_folder}" | rm_ampersand)"

        # Finding local root Google Drive folder
        gd_root_folder="$(.drive-find-gd)"
        return_code=$?

        # Removing all occurrences of '&' in $gd_root_folder as a workaround to a markup ampersand issue with zenity
        noamp_gd_root_folder="$(echo "${gd_root_folder}" | rm_ampersand)"

        case $return_code in
                0)
                        # Everything is fine - we continue
                        ;;
                7)
                        zenity --warning --title "Drive context found in $noamp_gd_root_folder" --text="We have moved to $noamp_gd_root_folder\n\nIf you prefer to select another Google Drive folder:\n\t--> 'Change local folder' in drive-menu" --width 1400

                        cd "$gd_root_folder"

                        local_folder="$(pwd)"

                        # Removing all occurrences of '&' in $object as a workaround to a markup ampersand issue with zenity
                        noamp_local_folder="$(echo "${local_folder}" | rm_ampersand)"
                        ;;
                8)
                        zenity --error --title "No drive context found below and above $noamp_local_folder" --text="- either drive has not been initialized properly (at least one hop away from '/') with:\n\t--> '# drive init google_drive_folder' within a terminal\n- or we are not located below your google_drive_folder top level branch:\n\t--> 'Change local folder' in drive-menu" --width 1400
                        exit $return_code
                        ;;
                *)
                        # Something is fatally wrong
                        zenity --error --title "Fatal error in drive-menu" --text="\tUnknown return code from .drive-find-gd: $return_code\n\nPlease report that issue to: https://gitlab.com/jean-christophe-manciot/Drive/issues" --width 1200
                        exit 99
                        ;;
        esac

        # Filtering & sorting the objects list
        filtered_objects=()
        readarray -t filtered_objects < <(.drive-select-objects 'remote_fs' 'list-shared')

        if [[ "${filtered_objects[0]}" =~ 'Connection error accessing your Google Drive online in' ]]; then
                # Nothing can be done
                zenity --error --title "Fatal Error" --text="Operation cancelled" --width 800
                exit 9
        elif [[ ${#filtered_objects[@]} -eq 0 ]]; then
                zenity --warning --title "Checking 0 remote Google Drive objects in ${noamp_local_folder}" --text="None needs to be checked" --width=1400
                exit 0
        fi

        printf '%s\n' "${filtered_objects[@]}" | zenity --text-info --title "Do you confirm seeking the shared objects among the following ${#filtered_objects[@]} remote Google Drive objects in ${noamp_local_folder}?" --width 1800 --height 800
        if [[ ${PIPESTATUS[1]} -eq 0 ]]; then
                # OK has been selected
                > .driveoutput.log

                # Checking all objects listed in "${filtered_objects[@]}"
                list-shared-objects | zenity --progress --percentage=0 --auto-close --title="Checking ${#filtered_objects[@]} remote Google Drive objects" --width 1800

                if [[ $(stat -L -c %s '.driveoutput.log') -eq 0 ]]; then
                        zenity --warning --title "Listing 0 shared remote Google Drive objects in ${noamp_local_folder}" --text="None is shared" --width=1400
                        exit 0
                fi

                readarray -t dashes < <(cat .driveoutput.log | select_delimiter)
                readarray -t unknowns < <(cat .driveoutput.log | select_Unknown_object_type)

                cat .driveoutput.log | zenity --text-info --title "Listing $((${#dashes[@]} - ${#unknowns[@]})) shared /${#filtered_objects[@]} selected remote Google Drive objects in ${noamp_local_folder}" --width 1800 --height 800
                rm .driveoutput.log
        else
                zenity --warning --title "Do you confirm seeking the shared objects among the following ${#filtered_objects[@]} remote Google Drive objects?" --text="Operation cancelled" --width=1200
                exit 3
        fi

        exit 0
else
        # Any parameter
        end_of_help_message_line_number=$(awk '/^if \[\[ \$LOG_/{ print NR; exit }' $(which drive-list-shared))
        ((end_of_help_message_line_number--))
        awk -v var=$end_of_help_message_line_number 'NR >= 20 && NR <= var' $(which drive-list-shared) | zenity --text-info --title "drive-list-shared help" --width 1150 --height 1000
        exit 1
fi