|
| 1 | +package main |
| 2 | + |
| 3 | +import ( |
| 4 | + "context" |
| 5 | + "flag" |
| 6 | + "fmt" |
| 7 | + "os" |
| 8 | + "strings" |
| 9 | + "time" |
| 10 | + |
| 11 | + "github.com/jedib0t/go-pretty/v6/table" |
| 12 | + |
| 13 | + "github.com/sourcegraph/src-cli/internal/api" |
| 14 | +) |
| 15 | + |
| 16 | +func init() { |
| 17 | + usage := ` |
| 18 | +This command removes users from a Sourcegraph instance who have been inactive for 60 or more days. Admin accounts are omitted by default. |
| 19 | + |
| 20 | +Examples: |
| 21 | +
|
| 22 | + $ src users clean -days 182 |
| 23 | + |
| 24 | + $ src users clean -remove-admin -remove-never-active |
| 25 | +` |
| 26 | + |
| 27 | + flagSet := flag.NewFlagSet("clean", flag.ExitOnError) |
| 28 | + usageFunc := func() { |
| 29 | + fmt.Fprintf(flag.CommandLine.Output(), "Usage of 'src users %s':\n", flagSet.Name()) |
| 30 | + flagSet.PrintDefaults() |
| 31 | + fmt.Println(usage) |
| 32 | + } |
| 33 | + var ( |
| 34 | + daysToDelete = flagSet.Int("days", 60, "Days threshold on which to remove users, must be 60 days or greater and defaults to this value ") |
| 35 | + removeAdmin = flagSet.Bool("remove-admin", false, "clean admin accounts") |
| 36 | + removeNoLastActive = flagSet.Bool("remove-never-active", false, "removes users with null lastActive value") |
| 37 | + skipConfirmation = flagSet.Bool("force", false, "skips user confirmation step allowing programmatic use") |
| 38 | + apiFlags = api.NewFlags(flagSet) |
| 39 | + ) |
| 40 | + |
| 41 | + handler := func(args []string) error { |
| 42 | + if err := flagSet.Parse(args); err != nil { |
| 43 | + return err |
| 44 | + } |
| 45 | + if *daysToDelete < 60 { |
| 46 | + fmt.Println("-days flag must be set to 60 or greater") |
| 47 | + return nil |
| 48 | + } |
| 49 | + |
| 50 | + ctx := context.Background() |
| 51 | + client := cfg.apiClient(apiFlags, flagSet.Output()) |
| 52 | + |
| 53 | + currentUserQuery := ` |
| 54 | +query { |
| 55 | + currentUser { |
| 56 | + username |
| 57 | + } |
| 58 | +} |
| 59 | +` |
| 60 | + var currentUserResult struct { |
| 61 | + Data struct { |
| 62 | + CurrentUser struct { |
| 63 | + Username string |
| 64 | + } |
| 65 | + } |
| 66 | + } |
| 67 | + if ok, err := cfg.apiClient(apiFlags, flagSet.Output()).NewRequest(currentUserQuery, nil).DoRaw(context.Background(), ¤tUserResult); err != nil || !ok { |
| 68 | + return err |
| 69 | + } |
| 70 | + fmt.Println(currentUserResult) |
| 71 | + |
| 72 | + usersQuery := ` |
| 73 | +query Users() { |
| 74 | + users() { |
| 75 | + nodes { |
| 76 | + ...UserFields |
| 77 | + } |
| 78 | + } |
| 79 | +} |
| 80 | +` + userFragment |
| 81 | + |
| 82 | + // get users to delete |
| 83 | + var usersResult struct { |
| 84 | + Users struct { |
| 85 | + Nodes []User |
| 86 | + } |
| 87 | + } |
| 88 | + if ok, err := client.NewRequest(usersQuery, nil).Do(ctx, &usersResult); err != nil || !ok { |
| 89 | + return err |
| 90 | + } |
| 91 | + fmt.Println(usersResult) |
| 92 | + |
| 93 | + usersToDelete := make([]UserToDelete, 0) |
| 94 | + for _, user := range usersResult.Users.Nodes { |
| 95 | + daysSinceLastUse, wasLastActive, err := computeDaysSinceLastUse(user) |
| 96 | + if err != nil { |
| 97 | + return err |
| 98 | + } |
| 99 | + // never remove user issuing command |
| 100 | + if user.Username == currentUserResult.Data.CurrentUser.Username { |
| 101 | + continue |
| 102 | + } |
| 103 | + if !wasLastActive && !*removeNoLastActive { |
| 104 | + continue |
| 105 | + } |
| 106 | + if !*removeAdmin && user.SiteAdmin { |
| 107 | + continue |
| 108 | + } |
| 109 | + if daysSinceLastUse <= *daysToDelete && wasLastActive { |
| 110 | + continue |
| 111 | + } |
| 112 | + deleteUser := UserToDelete{user, daysSinceLastUse} |
| 113 | + |
| 114 | + usersToDelete = append(usersToDelete, deleteUser) |
| 115 | + } |
| 116 | + |
| 117 | + if *skipConfirmation { |
| 118 | + for _, user := range usersToDelete { |
| 119 | + if err := removeUser(user.User, client, ctx); err != nil { |
| 120 | + return err |
| 121 | + } |
| 122 | + } |
| 123 | + return nil |
| 124 | + } |
| 125 | + |
| 126 | + // confirm and remove users |
| 127 | + if confirmed, _ := confirmUserRemoval(usersToDelete); !confirmed { |
| 128 | + fmt.Println("Aborting removal") |
| 129 | + return nil |
| 130 | + } else { |
| 131 | + fmt.Println("REMOVING USERS") |
| 132 | + for _, user := range usersToDelete { |
| 133 | + if err := removeUser(user.User, client, ctx); err != nil { |
| 134 | + return err |
| 135 | + } |
| 136 | + } |
| 137 | + } |
| 138 | + |
| 139 | + return nil |
| 140 | + } |
| 141 | + |
| 142 | + // Register the command. |
| 143 | + usersCommands = append(usersCommands, &command{ |
| 144 | + flagSet: flagSet, |
| 145 | + handler: handler, |
| 146 | + usageFunc: usageFunc, |
| 147 | + }) |
| 148 | +} |
| 149 | + |
| 150 | +// computes days since last usage from current day and time and UsageStatistics.LastActiveTime, uses time.Parse |
| 151 | +func computeDaysSinceLastUse(user User) (timeDiff int, wasLastActive bool, _ error) { |
| 152 | + // handle for null lastActiveTime returned from |
| 153 | + if user.UsageStatistics.LastActiveTime == "" { |
| 154 | + wasLastActive = false |
| 155 | + return 0, wasLastActive, nil |
| 156 | + } |
| 157 | + timeLast, err := time.Parse(time.RFC3339, user.UsageStatistics.LastActiveTime) |
| 158 | + if err != nil { |
| 159 | + return 0, false, err |
| 160 | + } |
| 161 | + timeDiff = int(time.Since(timeLast).Hours() / 24) |
| 162 | + |
| 163 | + return timeDiff, true, err |
| 164 | +} |
| 165 | + |
| 166 | +// Issue graphQL api request to remove user |
| 167 | +func removeUser(user User, client api.Client, ctx context.Context) error { |
| 168 | + query := `mutation DeleteUser($user: ID!) { |
| 169 | + deleteUser(user: $user) { |
| 170 | + alwaysNil |
| 171 | + } |
| 172 | +}` |
| 173 | + vars := map[string]interface{}{ |
| 174 | + "user": user.ID, |
| 175 | + } |
| 176 | + if ok, err := client.NewRequest(query, vars).Do(ctx, nil); err != nil || !ok { |
| 177 | + return err |
| 178 | + } |
| 179 | + return nil |
| 180 | +} |
| 181 | + |
| 182 | +type UserToDelete struct { |
| 183 | + User User |
| 184 | + DaysSinceLastUse int |
| 185 | +} |
| 186 | + |
| 187 | +// Verify user wants to remove users with table of users and a command prompt for [y/N] |
| 188 | +func confirmUserRemoval(usersToRemove []UserToDelete) (bool, error) { |
| 189 | + fmt.Printf("Users to remove from instance at %s\n", cfg.Endpoint) |
| 190 | + t := table.NewWriter() |
| 191 | + t.SetOutputMirror(os.Stdout) |
| 192 | + t.AppendHeader(table.Row{"Username", "Email", "Days Since Last Active"}) |
| 193 | + for _, user := range usersToRemove { |
| 194 | + if len(user.User.Emails) > 0 { |
| 195 | + t.AppendRow([]interface{}{user.User.Username, user.User.Emails[0].Email, user.DaysSinceLastUse}) |
| 196 | + t.AppendSeparator() |
| 197 | + } else { |
| 198 | + t.AppendRow([]interface{}{user.User.Username, "", user.DaysSinceLastUse}) |
| 199 | + t.AppendSeparator() |
| 200 | + } |
| 201 | + } |
| 202 | + t.SetStyle(table.StyleRounded) |
| 203 | + t.Render() |
| 204 | + input := "" |
| 205 | + for strings.ToLower(input) != "y" && strings.ToLower(input) != "n" { |
| 206 | + fmt.Printf("Do you wish to proceed with user removal [y/N]: ") |
| 207 | + if _, err := fmt.Scanln(&input); err != nil { |
| 208 | + return false, err |
| 209 | + } |
| 210 | + } |
| 211 | + return strings.ToLower(input) == "y", nil |
| 212 | +} |
0 commit comments