James Moger
2011-12-23 31bcbea4c35e29d3b5147d33a41544cb125cf694
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
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
/*
 * Copyright 2011 gitblit.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
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.gitblit;
 
import java.io.BufferedReader;
import java.io.File;
import java.io.FileFilter;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.lang.reflect.Field;
import java.text.MessageFormat;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.Executors;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicInteger;
 
import javax.mail.Message;
import javax.mail.MessagingException;
import javax.servlet.ServletContext;
import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;
import javax.servlet.http.Cookie;
 
import org.apache.wicket.protocol.http.WebResponse;
import org.eclipse.jgit.errors.RepositoryNotFoundException;
import org.eclipse.jgit.lib.Repository;
import org.eclipse.jgit.lib.RepositoryCache.FileKey;
import org.eclipse.jgit.lib.StoredConfig;
import org.eclipse.jgit.transport.resolver.FileResolver;
import org.eclipse.jgit.transport.resolver.RepositoryResolver;
import org.eclipse.jgit.transport.resolver.ServiceNotAuthorizedException;
import org.eclipse.jgit.transport.resolver.ServiceNotEnabledException;
import org.eclipse.jgit.util.FS;
import org.eclipse.jgit.util.FileUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
 
import com.gitblit.Constants.AccessRestrictionType;
import com.gitblit.Constants.FederationRequest;
import com.gitblit.Constants.FederationStrategy;
import com.gitblit.Constants.FederationToken;
import com.gitblit.models.FederationModel;
import com.gitblit.models.FederationProposal;
import com.gitblit.models.FederationSet;
import com.gitblit.models.Metric;
import com.gitblit.models.RepositoryModel;
import com.gitblit.models.ServerSettings;
import com.gitblit.models.ServerStatus;
import com.gitblit.models.SettingModel;
import com.gitblit.models.TeamModel;
import com.gitblit.models.UserModel;
import com.gitblit.utils.ByteFormat;
import com.gitblit.utils.FederationUtils;
import com.gitblit.utils.JGitUtils;
import com.gitblit.utils.JsonUtils;
import com.gitblit.utils.MetricUtils;
import com.gitblit.utils.ObjectCache;
import com.gitblit.utils.StringUtils;
 
/**
 * GitBlit is the servlet context listener singleton that acts as the core for
 * the web ui and the servlets. This class is either directly instantiated by
 * the GitBlitServer class (Gitblit GO) or is reflectively instantiated from the
 * definition in the web.xml file (Gitblit WAR).
 * 
 * This class is the central logic processor for Gitblit. All settings, user
 * object, and repository object operations pass through this class.
 * 
 * Repository Resolution. There are two pathways for finding repositories. One
 * pathway, for web ui display and repository authentication & authorization, is
 * within this class. The other pathway is through the standard GitServlet.
 * 
 * @author James Moger
 * 
 */
public class GitBlit implements ServletContextListener {
 
    private static GitBlit gitblit;
 
    private final Logger logger = LoggerFactory.getLogger(GitBlit.class);
 
    private final ScheduledExecutorService scheduledExecutor = Executors.newScheduledThreadPool(5);
 
    private final List<FederationModel> federationRegistrations = Collections
            .synchronizedList(new ArrayList<FederationModel>());
 
    private final Map<String, FederationModel> federationPullResults = new ConcurrentHashMap<String, FederationModel>();
 
    private final ObjectCache<Long> repositorySizeCache = new ObjectCache<Long>();
 
    private final ObjectCache<List<Metric>> repositoryMetricsCache = new ObjectCache<List<Metric>>();
 
    private RepositoryResolver<Void> repositoryResolver;
 
    private ServletContext servletContext;
 
    private File repositoriesFolder;
 
    private boolean exportAll = true;
 
    private IUserService userService;
 
    private IStoredSettings settings;
 
    private ServerSettings settingsModel;
 
    private ServerStatus serverStatus;
 
    private MailExecutor mailExecutor;
 
    public GitBlit() {
        if (gitblit == null) {
            // set the static singleton reference
            gitblit = this;
        }
    }
 
    /**
     * Returns the Gitblit singleton.
     * 
     * @return gitblit singleton
     */
    public static GitBlit self() {
        if (gitblit == null) {
            new GitBlit();
        }
        return gitblit;
    }
 
    /**
     * Determine if this is the GO variant of Gitblit.
     * 
     * @return true if this is the GO variant of Gitblit.
     */
    public static boolean isGO() {
        return self().settings instanceof FileSettings;
    }
 
    /**
     * Returns the boolean value for the specified key. If the key does not
     * exist or the value for the key can not be interpreted as a boolean, the
     * defaultValue is returned.
     * 
     * @see IStoredSettings.getBoolean(String, boolean)
     * @param key
     * @param defaultValue
     * @return key value or defaultValue
     */
    public static boolean getBoolean(String key, boolean defaultValue) {
        return self().settings.getBoolean(key, defaultValue);
    }
 
    /**
     * Returns the integer value for the specified key. If the key does not
     * exist or the value for the key can not be interpreted as an integer, the
     * defaultValue is returned.
     * 
     * @see IStoredSettings.getInteger(String key, int defaultValue)
     * @param key
     * @param defaultValue
     * @return key value or defaultValue
     */
    public static int getInteger(String key, int defaultValue) {
        return self().settings.getInteger(key, defaultValue);
    }
 
    /**
     * Returns the char value for the specified key. If the key does not exist
     * or the value for the key can not be interpreted as a character, the
     * defaultValue is returned.
     * 
     * @see IStoredSettings.getChar(String key, char defaultValue)
     * @param key
     * @param defaultValue
     * @return key value or defaultValue
     */
    public static char getChar(String key, char defaultValue) {
        return self().settings.getChar(key, defaultValue);
    }
 
    /**
     * Returns the string value for the specified key. If the key does not exist
     * or the value for the key can not be interpreted as a string, the
     * defaultValue is returned.
     * 
     * @see IStoredSettings.getString(String key, String defaultValue)
     * @param key
     * @param defaultValue
     * @return key value or defaultValue
     */
    public static String getString(String key, String defaultValue) {
        return self().settings.getString(key, defaultValue);
    }
 
    /**
     * Returns a list of space-separated strings from the specified key.
     * 
     * @see IStoredSettings.getStrings(String key)
     * @param name
     * @return list of strings
     */
    public static List<String> getStrings(String key) {
        return self().settings.getStrings(key);
    }
 
    /**
     * Returns the list of keys whose name starts with the specified prefix. If
     * the prefix is null or empty, all key names are returned.
     * 
     * @see IStoredSettings.getAllKeys(String key)
     * @param startingWith
     * @return list of keys
     */
 
    public static List<String> getAllKeys(String startingWith) {
        return self().settings.getAllKeys(startingWith);
    }
 
    /**
     * Is Gitblit running in debug mode?
     * 
     * @return true if Gitblit is running in debug mode
     */
    public static boolean isDebugMode() {
        return self().settings.getBoolean(Keys.web.debugMode, false);
    }
 
    /**
     * Returns the file object for the specified configuration key.
     * 
     * @return the file
     */
    public static File getFileOrFolder(String key, String defaultFileOrFolder) {
        String fileOrFolder = GitBlit.getString(key, defaultFileOrFolder);
        return getFileOrFolder(fileOrFolder);
    }
 
    /**
     * Returns the file object which may have it's base-path determined by
     * environment variables for running on a cloud hosting service. All Gitblit
     * file or folder retrievals are (at least initially) funneled through this
     * method so it is the correct point to globally override/alter filesystem
     * access based on environment or some other indicator.
     * 
     * @return the file
     */
    public static File getFileOrFolder(String fileOrFolder) {
        String openShift = System.getenv("OPENSHIFT_DATA_DIR");
        if (!StringUtils.isEmpty(openShift)) {
            // running on RedHat OpenShift
            return new File(openShift, fileOrFolder);
        }
        return new File(fileOrFolder);
    }
 
    /**
     * Returns the path of the repositories folder. This method checks to see if
     * Gitblit is running on a cloud service and may return an adjusted path.
     * 
     * @return the repositories folder path
     */
    public static File getRepositoriesFolder() {
        return getFileOrFolder(Keys.git.repositoriesFolder, "git");
    }
 
    /**
     * Returns the path of the proposals folder. This method checks to see if
     * Gitblit is running on a cloud service and may return an adjusted path.
     * 
     * @return the proposals folder path
     */
    public static File getProposalsFolder() {
        return getFileOrFolder(Keys.federation.proposalsFolder, "proposals");
    }
 
    /**
     * Returns the path of the Groovy folder. This method checks to see if
     * Gitblit is running on a cloud service and may return an adjusted path.
     * 
     * @return the Groovy scripts folder path
     */
    public static File getGroovyScriptsFolder() {
        return getFileOrFolder(Keys.groovy.scriptsFolder, "groovy");
    }
 
    /**
     * Updates the list of server settings.
     * 
     * @param settings
     * @return true if the update succeeded
     */
    public boolean updateSettings(Map<String, String> updatedSettings) {
        return settings.saveSettings(updatedSettings);
    }
 
    public ServerStatus getStatus() {
        // update heap memory status
        serverStatus.heapAllocated = Runtime.getRuntime().totalMemory();
        serverStatus.heapFree = Runtime.getRuntime().freeMemory();
        return serverStatus;
    }
 
    /**
     * Returns the list of non-Gitblit clone urls. This allows Gitblit to
     * advertise alternative urls for Git client repository access.
     * 
     * @param repositoryName
     * @return list of non-gitblit clone urls
     */
    public List<String> getOtherCloneUrls(String repositoryName) {
        List<String> cloneUrls = new ArrayList<String>();
        for (String url : settings.getStrings(Keys.web.otherUrls)) {
            cloneUrls.add(MessageFormat.format(url, repositoryName));
        }
        return cloneUrls;
    }
 
    /**
     * Set the user service. The user service authenticates all users and is
     * responsible for managing user permissions.
     * 
     * @param userService
     */
    public void setUserService(IUserService userService) {
        logger.info("Setting up user service " + userService.toString());
        this.userService = userService;
        this.userService.setup(settings);
    }
 
    /**
     * Authenticate a user based on a username and password.
     * 
     * @see IUserService.authenticate(String, char[])
     * @param username
     * @param password
     * @return a user object or null
     */
    public UserModel authenticate(String username, char[] password) {
        if (StringUtils.isEmpty(username)) {
            // can not authenticate empty username
            return null;
        }
        String pw = new String(password);
        if (StringUtils.isEmpty(pw)) {
            // can not authenticate empty password
            return null;
        }
 
        // check to see if this is the federation user
        if (canFederate()) {
            if (username.equalsIgnoreCase(Constants.FEDERATION_USER)) {
                List<String> tokens = getFederationTokens();
                if (tokens.contains(pw)) {
                    // the federation user is an administrator
                    UserModel federationUser = new UserModel(Constants.FEDERATION_USER);
                    federationUser.canAdmin = true;
                    return federationUser;
                }
            }
        }
 
        // delegate authentication to the user service
        if (userService == null) {
            return null;
        }
        return userService.authenticate(username, password);
    }
 
    /**
     * Authenticate a user based on their cookie.
     * 
     * @param cookies
     * @return a user object or null
     */
    public UserModel authenticate(Cookie[] cookies) {
        if (userService == null) {
            return null;
        }
        if (userService.supportsCookies()) {
            if (cookies != null && cookies.length > 0) {
                for (Cookie cookie : cookies) {
                    if (cookie.getName().equals(Constants.NAME)) {
                        String value = cookie.getValue();
                        return userService.authenticate(value.toCharArray());
                    }
                }
            }
        }
        return null;
    }
 
    /**
     * Sets a cookie for the specified user.
     * 
     * @param response
     * @param user
     */
    public void setCookie(WebResponse response, UserModel user) {
        if (userService == null) {
            return;
        }
        if (userService.supportsCookies()) {
            Cookie userCookie;
            if (user == null) {
                // clear cookie for logout
                userCookie = new Cookie(Constants.NAME, "");
            } else {
                // set cookie for login
                char[] cookie = userService.getCookie(user);
                userCookie = new Cookie(Constants.NAME, new String(cookie));
                userCookie.setMaxAge(Integer.MAX_VALUE);
            }
            userCookie.setPath("/");
            response.addCookie(userCookie);
        }
    }
 
    /**
     * Returns the list of all users available to the login service.
     * 
     * @see IUserService.getAllUsernames()
     * @return list of all usernames
     */
    public List<String> getAllUsernames() {
        List<String> names = new ArrayList<String>(userService.getAllUsernames());
        Collections.sort(names);
        return names;
    }
 
    /**
     * Delete the user object with the specified username
     * 
     * @see IUserService.deleteUser(String)
     * @param username
     * @return true if successful
     */
    public boolean deleteUser(String username) {
        return userService.deleteUser(username);
    }
 
    /**
     * Retrieve the user object for the specified username.
     * 
     * @see IUserService.getUserModel(String)
     * @param username
     * @return a user object or null
     */
    public UserModel getUserModel(String username) {
        UserModel user = userService.getUserModel(username);
        return user;
    }
 
    /**
     * Returns the list of all users who are allowed to bypass the access
     * restriction placed on the specified repository.
     * 
     * @see IUserService.getUsernamesForRepositoryRole(String)
     * @param repository
     * @return list of all usernames that can bypass the access restriction
     */
    public List<String> getRepositoryUsers(RepositoryModel repository) {
        return userService.getUsernamesForRepositoryRole(repository.name);
    }
 
    /**
     * Sets the list of all uses who are allowed to bypass the access
     * restriction placed on the specified repository.
     * 
     * @see IUserService.setUsernamesForRepositoryRole(String, List<String>)
     * @param repository
     * @param usernames
     * @return true if successful
     */
    public boolean setRepositoryUsers(RepositoryModel repository, List<String> repositoryUsers) {
        return userService.setUsernamesForRepositoryRole(repository.name, repositoryUsers);
    }
 
    /**
     * Adds/updates a complete user object keyed by username. This method allows
     * for renaming a user.
     * 
     * @see IUserService.updateUserModel(String, UserModel)
     * @param username
     * @param user
     * @param isCreate
     * @throws GitBlitException
     */
    public void updateUserModel(String username, UserModel user, boolean isCreate)
            throws GitBlitException {
        if (!username.equalsIgnoreCase(user.username)) {
            if (userService.getUserModel(user.username) != null) {
                throw new GitBlitException(MessageFormat.format(
                        "Failed to rename ''{0}'' because ''{1}'' already exists.", username,
                        user.username));
            }
        }
        if (!userService.updateUserModel(username, user)) {
            throw new GitBlitException(isCreate ? "Failed to add user!" : "Failed to update user!");
        }
    }
 
    /**
     * Returns the list of available teams that a user or repository may be
     * assigned to.
     * 
     * @return the list of teams
     */
    public List<String> getAllTeamnames() {
        List<String> teams = new ArrayList<String>(userService.getAllTeamNames());
        Collections.sort(teams);
        return teams;
    }
 
    /**
     * Returns the TeamModel object for the specified name.
     * 
     * @param teamname
     * @return a TeamModel object or null
     */
    public TeamModel getTeamModel(String teamname) {
        return userService.getTeamModel(teamname);
    }
 
    /**
     * Returns the list of all teams who are allowed to bypass the access
     * restriction placed on the specified repository.
     * 
     * @see IUserService.getTeamnamesForRepositoryRole(String)
     * @param repository
     * @return list of all teamnames that can bypass the access restriction
     */
    public List<String> getRepositoryTeams(RepositoryModel repository) {
        return userService.getTeamnamesForRepositoryRole(repository.name);
    }
 
    /**
     * Sets the list of all uses who are allowed to bypass the access
     * restriction placed on the specified repository.
     * 
     * @see IUserService.setTeamnamesForRepositoryRole(String, List<String>)
     * @param repository
     * @param teamnames
     * @return true if successful
     */
    public boolean setRepositoryTeams(RepositoryModel repository, List<String> repositoryTeams) {
        return userService.setTeamnamesForRepositoryRole(repository.name, repositoryTeams);
    }
 
    /**
     * Updates the TeamModel object for the specified name.
     * 
     * @param teamname
     * @param team
     * @param isCreate
     */
    public void updateTeamModel(String teamname, TeamModel team, boolean isCreate)
            throws GitBlitException {
        if (!teamname.equalsIgnoreCase(team.name)) {
            if (userService.getTeamModel(team.name) != null) {
                throw new GitBlitException(MessageFormat.format(
                        "Failed to rename ''{0}'' because ''{1}'' already exists.", teamname,
                        team.name));
            }
        }
        if (!userService.updateTeamModel(teamname, team)) {
            throw new GitBlitException(isCreate ? "Failed to add team!" : "Failed to update team!");
        }
    }
 
    /**
     * Delete the team object with the specified teamname
     * 
     * @see IUserService.deleteTeam(String)
     * @param teamname
     * @return true if successful
     */
    public boolean deleteTeam(String teamname) {
        return userService.deleteTeam(teamname);
    }
 
    /**
     * Clears all the cached data for the specified repository.
     * 
     * @param repositoryName
     */
    public void clearRepositoryCache(String repositoryName) {
        repositorySizeCache.remove(repositoryName);
        repositoryMetricsCache.remove(repositoryName);
    }
 
    /**
     * Returns the list of all repositories available to Gitblit. This method
     * does not consider user access permissions.
     * 
     * @return list of all repositories
     */
    public List<String> getRepositoryList() {
        return JGitUtils.getRepositoryList(repositoriesFolder, exportAll,
                settings.getBoolean(Keys.git.searchRepositoriesSubfolders, true));
    }
 
    /**
     * Returns the JGit repository for the specified name.
     * 
     * @param repositoryName
     * @return repository or null
     */
    public Repository getRepository(String repositoryName) {
        Repository r = null;
        try {
            r = repositoryResolver.open(null, repositoryName);
        } catch (RepositoryNotFoundException e) {
            r = null;
            logger.error("GitBlit.getRepository(String) failed to find "
                    + new File(repositoriesFolder, repositoryName).getAbsolutePath());
        } catch (ServiceNotAuthorizedException e) {
            r = null;
            logger.error("GitBlit.getRepository(String) failed to find "
                    + new File(repositoriesFolder, repositoryName).getAbsolutePath(), e);
        } catch (ServiceNotEnabledException e) {
            r = null;
            logger.error("GitBlit.getRepository(String) failed to find "
                    + new File(repositoriesFolder, repositoryName).getAbsolutePath(), e);
        }
        return r;
    }
 
    /**
     * Returns the list of repository models that are accessible to the user.
     * 
     * @param user
     * @return list of repository models accessible to user
     */
    public List<RepositoryModel> getRepositoryModels(UserModel user) {
        List<String> list = getRepositoryList();
        List<RepositoryModel> repositories = new ArrayList<RepositoryModel>();
        for (String repo : list) {
            RepositoryModel model = getRepositoryModel(user, repo);
            if (model != null) {
                repositories.add(model);
            }
        }
        if (getBoolean(Keys.web.showRepositorySizes, true)) {
            int repoCount = 0;
            long startTime = System.currentTimeMillis();
            ByteFormat byteFormat = new ByteFormat();
            for (RepositoryModel model : repositories) {
                if (!model.skipSizeCalculation) {
                    repoCount++;
                    model.size = byteFormat.format(calculateSize(model));
                }
            }
            long duration = System.currentTimeMillis() - startTime;
            logger.info(MessageFormat.format("{0} repository sizes calculated in {1} msecs",
                    repoCount, duration));
        }
        return repositories;
    }
 
    /**
     * Returns a repository model if the repository exists and the user may
     * access the repository.
     * 
     * @param user
     * @param repositoryName
     * @return repository model or null
     */
    public RepositoryModel getRepositoryModel(UserModel user, String repositoryName) {
        RepositoryModel model = getRepositoryModel(repositoryName);
        if (model == null) {
            return null;
        }
        if (model.accessRestriction.atLeast(AccessRestrictionType.VIEW)) {
            if (user != null && user.canAccessRepository(model)) {
                return model;
            }
            return null;
        } else {
            return model;
        }
    }
 
    /**
     * Returns the repository model for the specified repository. This method
     * does not consider user access permissions.
     * 
     * @param repositoryName
     * @return repository model or null
     */
    public RepositoryModel getRepositoryModel(String repositoryName) {
        Repository r = getRepository(repositoryName);
        if (r == null) {
            return null;
        }
        RepositoryModel model = new RepositoryModel();
        model.name = repositoryName;
        model.hasCommits = JGitUtils.hasCommits(r);
        model.lastChange = JGitUtils.getLastChange(r, null);
        StoredConfig config = JGitUtils.readConfig(r);
        if (config != null) {
            model.description = getConfig(config, "description", "");
            model.owner = getConfig(config, "owner", "");
            model.useTickets = getConfig(config, "useTickets", false);
            model.useDocs = getConfig(config, "useDocs", false);
            model.accessRestriction = AccessRestrictionType.fromName(getConfig(config,
                    "accessRestriction", null));
            model.showRemoteBranches = getConfig(config, "showRemoteBranches", false);
            model.isFrozen = getConfig(config, "isFrozen", false);
            model.showReadme = getConfig(config, "showReadme", false);
            model.skipSizeCalculation = getConfig(config, "skipSizeCalculation", false);
            model.skipSummaryMetrics = getConfig(config, "skipSummaryMetrics", false);
            model.federationStrategy = FederationStrategy.fromName(getConfig(config,
                    "federationStrategy", null));
            model.federationSets = new ArrayList<String>(Arrays.asList(config.getStringList(
                    "gitblit", null, "federationSets")));
            model.isFederated = getConfig(config, "isFederated", false);
            model.origin = config.getString("remote", "origin", "url");
            model.preReceiveScripts = new ArrayList<String>(Arrays.asList(config.getStringList(
                    "gitblit", null, "preReceiveScript")));
            model.postReceiveScripts = new ArrayList<String>(Arrays.asList(config.getStringList(
                    "gitblit", null, "postReceiveScript")));
            model.mailingLists = new ArrayList<String>(Arrays.asList(config.getStringList(
                    "gitblit", null, "mailingList")));
        }
        r.close();
        return model;
    }
 
    /**
     * Returns the size in bytes of the repository. Gitblit caches the
     * repository sizes to reduce the performance penalty of recursive
     * calculation. The cache is updated if the repository has been changed
     * since the last calculation.
     * 
     * @param model
     * @return size in bytes
     */
    public long calculateSize(RepositoryModel model) {
        if (repositorySizeCache.hasCurrent(model.name, model.lastChange)) {
            return repositorySizeCache.getObject(model.name);
        }
        File gitDir = FileKey.resolve(new File(repositoriesFolder, model.name), FS.DETECTED);
        long size = com.gitblit.utils.FileUtils.folderSize(gitDir);
        repositorySizeCache.updateObject(model.name, model.lastChange, size);
        return size;
    }
 
    /**
     * Ensure that a cached repository is completely closed and its resources
     * are properly released.
     * 
     * @param repositoryName
     */
    private void closeRepository(String repositoryName) {
        Repository repository = getRepository(repositoryName);
        // assume 2 uses in case reflection fails
        int uses = 2;
        try {
            // The FileResolver caches repositories which is very useful
            // for performance until you want to delete a repository.
            // I have to use reflection to call close() the correct
            // number of times to ensure that the object and ref databases
            // are properly closed before I can delete the repository from
            // the filesystem.
            Field useCnt = Repository.class.getDeclaredField("useCnt");
            useCnt.setAccessible(true);
            uses = ((AtomicInteger) useCnt.get(repository)).get();
        } catch (Exception e) {
            logger.warn(MessageFormat
                    .format("Failed to reflectively determine use count for repository {0}",
                            repositoryName), e);
        }
        if (uses > 0) {
            logger.info(MessageFormat
                    .format("{0}.useCnt={1}, calling close() {2} time(s) to close object and ref databases",
                            repositoryName, uses, uses));
            for (int i = 0; i < uses; i++) {
                repository.close();
            }
        }
    }
 
    /**
     * Returns the metrics for the default branch of the specified repository.
     * This method builds a metrics cache. The cache is updated if the
     * repository is updated. A new copy of the metrics list is returned on each
     * call so that modifications to the list are non-destructive.
     * 
     * @param model
     * @param repository
     * @return a new array list of metrics
     */
    public List<Metric> getRepositoryDefaultMetrics(RepositoryModel model, Repository repository) {
        if (repositoryMetricsCache.hasCurrent(model.name, model.lastChange)) {
            return new ArrayList<Metric>(repositoryMetricsCache.getObject(model.name));
        }
        List<Metric> metrics = MetricUtils.getDateMetrics(repository, null, true, null);
        repositoryMetricsCache.updateObject(model.name, model.lastChange, metrics);
        return new ArrayList<Metric>(metrics);
    }
 
    /**
     * Returns the gitblit string value for the specified key. If key is not
     * set, returns defaultValue.
     * 
     * @param config
     * @param field
     * @param defaultValue
     * @return field value or defaultValue
     */
    private String getConfig(StoredConfig config, String field, String defaultValue) {
        String value = config.getString("gitblit", null, field);
        if (StringUtils.isEmpty(value)) {
            return defaultValue;
        }
        return value;
    }
 
    /**
     * Returns the gitblit boolean vlaue for the specified key. If key is not
     * set, returns defaultValue.
     * 
     * @param config
     * @param field
     * @param defaultValue
     * @return field value or defaultValue
     */
    private boolean getConfig(StoredConfig config, String field, boolean defaultValue) {
        return config.getBoolean("gitblit", field, defaultValue);
    }
 
    /**
     * Creates/updates the repository model keyed by reopsitoryName. Saves all
     * repository settings in .git/config. This method allows for renaming
     * repositories and will update user access permissions accordingly.
     * 
     * All repositories created by this method are bare and automatically have
     * .git appended to their names, which is the standard convention for bare
     * repositories.
     * 
     * @param repositoryName
     * @param repository
     * @param isCreate
     * @throws GitBlitException
     */
    public void updateRepositoryModel(String repositoryName, RepositoryModel repository,
            boolean isCreate) throws GitBlitException {
        Repository r = null;
        if (isCreate) {
            // ensure created repository name ends with .git
            if (!repository.name.toLowerCase().endsWith(org.eclipse.jgit.lib.Constants.DOT_GIT_EXT)) {
                repository.name += org.eclipse.jgit.lib.Constants.DOT_GIT_EXT;
            }
            if (new File(repositoriesFolder, repository.name).exists()) {
                throw new GitBlitException(MessageFormat.format(
                        "Can not create repository ''{0}'' because it already exists.",
                        repository.name));
            }
            // create repository
            logger.info("create repository " + repository.name);
            r = JGitUtils.createRepository(repositoriesFolder, repository.name);
        } else {
            // rename repository
            if (!repositoryName.equalsIgnoreCase(repository.name)) {
                if (!repository.name.toLowerCase().endsWith(
                        org.eclipse.jgit.lib.Constants.DOT_GIT_EXT)) {
                    repository.name += org.eclipse.jgit.lib.Constants.DOT_GIT_EXT;
                }
                if (new File(repositoriesFolder, repository.name).exists()) {
                    throw new GitBlitException(MessageFormat.format(
                            "Failed to rename ''{0}'' because ''{1}'' already exists.",
                            repositoryName, repository.name));
                }
                closeRepository(repositoryName);
                File folder = new File(repositoriesFolder, repositoryName);
                File destFolder = new File(repositoriesFolder, repository.name);
                if (destFolder.exists()) {
                    throw new GitBlitException(
                            MessageFormat
                                    .format("Can not rename repository ''{0}'' to ''{1}'' because ''{1}'' already exists.",
                                            repositoryName, repository.name));
                }
                if (!folder.renameTo(destFolder)) {
                    throw new GitBlitException(MessageFormat.format(
                            "Failed to rename repository ''{0}'' to ''{1}''.", repositoryName,
                            repository.name));
                }
                // rename the roles
                if (!userService.renameRepositoryRole(repositoryName, repository.name)) {
                    throw new GitBlitException(MessageFormat.format(
                            "Failed to rename repository permissions ''{0}'' to ''{1}''.",
                            repositoryName, repository.name));
                }
 
                // clear the cache
                clearRepositoryCache(repositoryName);
            }
 
            // load repository
            logger.info("edit repository " + repository.name);
            try {
                r = repositoryResolver.open(null, repository.name);
            } catch (RepositoryNotFoundException e) {
                logger.error("Repository not found", e);
            } catch (ServiceNotAuthorizedException e) {
                logger.error("Service not authorized", e);
            } catch (ServiceNotEnabledException e) {
                logger.error("Service not enabled", e);
            }
        }
 
        // update settings
        if (r != null) {
            updateConfiguration(r, repository);
            r.close();
        }
    }
 
    /**
     * Updates the Gitblit configuration for the specified repository.
     * 
     * @param r
     *            the Git repository
     * @param repository
     *            the Gitblit repository model
     */
    public void updateConfiguration(Repository r, RepositoryModel repository) {
        StoredConfig config = JGitUtils.readConfig(r);
        config.setString("gitblit", null, "description", repository.description);
        config.setString("gitblit", null, "owner", repository.owner);
        config.setBoolean("gitblit", null, "useTickets", repository.useTickets);
        config.setBoolean("gitblit", null, "useDocs", repository.useDocs);
        config.setString("gitblit", null, "accessRestriction", repository.accessRestriction.name());
        config.setBoolean("gitblit", null, "showRemoteBranches", repository.showRemoteBranches);
        config.setBoolean("gitblit", null, "isFrozen", repository.isFrozen);
        config.setBoolean("gitblit", null, "showReadme", repository.showReadme);
        config.setBoolean("gitblit", null, "skipSizeCalculation", repository.skipSizeCalculation);
        config.setBoolean("gitblit", null, "skipSummaryMetrics", repository.skipSummaryMetrics);
        config.setStringList("gitblit", null, "federationSets", repository.federationSets);
        config.setString("gitblit", null, "federationStrategy",
                repository.federationStrategy.name());
        config.setBoolean("gitblit", null, "isFederated", repository.isFederated);
        if (repository.preReceiveScripts != null) {
            config.setStringList("gitblit", null, "preReceiveScript", repository.preReceiveScripts);
        }
        if (repository.postReceiveScripts != null) {
            config.setStringList("gitblit", null, "postReceiveScript",
                    repository.postReceiveScripts);
        }
        if (repository.mailingLists != null) {
            config.setStringList("gitblit", null, "mailingList", repository.mailingLists);
        }
        try {
            config.save();
        } catch (IOException e) {
            logger.error("Failed to save repository config!", e);
        }
    }
 
    /**
     * Deletes the repository from the file system and removes the repository
     * permission from all repository users.
     * 
     * @param model
     * @return true if successful
     */
    public boolean deleteRepositoryModel(RepositoryModel model) {
        return deleteRepository(model.name);
    }
 
    /**
     * Deletes the repository from the file system and removes the repository
     * permission from all repository users.
     * 
     * @param repositoryName
     * @return true if successful
     */
    public boolean deleteRepository(String repositoryName) {
        try {
            closeRepository(repositoryName);
            File folder = new File(repositoriesFolder, repositoryName);
            if (folder.exists() && folder.isDirectory()) {
                FileUtils.delete(folder, FileUtils.RECURSIVE | FileUtils.RETRY);
                if (userService.deleteRepositoryRole(repositoryName)) {
                    return true;
                }
            }
 
            // clear the repository cache
            clearRepositoryCache(repositoryName);
        } catch (Throwable t) {
            logger.error(MessageFormat.format("Failed to delete repository {0}", repositoryName), t);
        }
        return false;
    }
 
    /**
     * Returns an html version of the commit message with any global or
     * repository-specific regular expression substitution applied.
     * 
     * @param repositoryName
     * @param text
     * @return html version of the commit message
     */
    public String processCommitMessage(String repositoryName, String text) {
        String html = StringUtils.breakLinesForHtml(text);
        Map<String, String> map = new HashMap<String, String>();
        // global regex keys
        if (settings.getBoolean(Keys.regex.global, false)) {
            for (String key : settings.getAllKeys(Keys.regex.global)) {
                if (!key.equals(Keys.regex.global)) {
                    String subKey = key.substring(key.lastIndexOf('.') + 1);
                    map.put(subKey, settings.getString(key, ""));
                }
            }
        }
 
        // repository-specific regex keys
        List<String> keys = settings.getAllKeys(Keys.regex._ROOT + "."
                + repositoryName.toLowerCase());
        for (String key : keys) {
            String subKey = key.substring(key.lastIndexOf('.') + 1);
            map.put(subKey, settings.getString(key, ""));
        }
 
        for (Entry<String, String> entry : map.entrySet()) {
            String definition = entry.getValue().trim();
            String[] chunks = definition.split("!!!");
            if (chunks.length == 2) {
                html = html.replaceAll(chunks[0], chunks[1]);
            } else {
                logger.warn(entry.getKey()
                        + " improperly formatted.  Use !!! to separate match from replacement: "
                        + definition);
            }
        }
        return html;
    }
 
    /**
     * Returns Gitblit's scheduled executor service for scheduling tasks.
     * 
     * @return scheduledExecutor
     */
    public ScheduledExecutorService executor() {
        return scheduledExecutor;
    }
 
    public static boolean canFederate() {
        String passphrase = getString(Keys.federation.passphrase, "");
        return !StringUtils.isEmpty(passphrase);
    }
 
    /**
     * Configures this Gitblit instance to pull any registered federated gitblit
     * instances.
     */
    private void configureFederation() {
        boolean validPassphrase = true;
        String passphrase = settings.getString(Keys.federation.passphrase, "");
        if (StringUtils.isEmpty(passphrase)) {
            logger.warn("Federation passphrase is blank! This server can not be PULLED from.");
            validPassphrase = false;
        }
        if (validPassphrase) {
            // standard tokens
            for (FederationToken tokenType : FederationToken.values()) {
                logger.info(MessageFormat.format("Federation {0} token = {1}", tokenType.name(),
                        getFederationToken(tokenType)));
            }
 
            // federation set tokens
            for (String set : settings.getStrings(Keys.federation.sets)) {
                logger.info(MessageFormat.format("Federation Set {0} token = {1}", set,
                        getFederationToken(set)));
            }
        }
 
        // Schedule the federation executor
        List<FederationModel> registrations = getFederationRegistrations();
        if (registrations.size() > 0) {
            FederationPullExecutor executor = new FederationPullExecutor(registrations, true);
            scheduledExecutor.schedule(executor, 1, TimeUnit.MINUTES);
        }
    }
 
    /**
     * Returns the list of federated gitblit instances that this instance will
     * try to pull.
     * 
     * @return list of registered gitblit instances
     */
    public List<FederationModel> getFederationRegistrations() {
        if (federationRegistrations.isEmpty()) {
            federationRegistrations.addAll(FederationUtils.getFederationRegistrations(settings));
        }
        return federationRegistrations;
    }
 
    /**
     * Retrieve the specified federation registration.
     * 
     * @param name
     *            the name of the registration
     * @return a federation registration
     */
    public FederationModel getFederationRegistration(String url, String name) {
        // check registrations
        for (FederationModel r : getFederationRegistrations()) {
            if (r.name.equals(name) && r.url.equals(url)) {
                return r;
            }
        }
 
        // check the results
        for (FederationModel r : getFederationResultRegistrations()) {
            if (r.name.equals(name) && r.url.equals(url)) {
                return r;
            }
        }
        return null;
    }
 
    /**
     * Returns the list of federation sets.
     * 
     * @return list of federation sets
     */
    public List<FederationSet> getFederationSets(String gitblitUrl) {
        List<FederationSet> list = new ArrayList<FederationSet>();
        // generate standard tokens
        for (FederationToken type : FederationToken.values()) {
            FederationSet fset = new FederationSet(type.toString(), type, getFederationToken(type));
            fset.repositories = getRepositories(gitblitUrl, fset.token);
            list.add(fset);
        }
        // generate tokens for federation sets
        for (String set : settings.getStrings(Keys.federation.sets)) {
            FederationSet fset = new FederationSet(set, FederationToken.REPOSITORIES,
                    getFederationToken(set));
            fset.repositories = getRepositories(gitblitUrl, fset.token);
            list.add(fset);
        }
        return list;
    }
 
    /**
     * Returns the list of possible federation tokens for this Gitblit instance.
     * 
     * @return list of federation tokens
     */
    public List<String> getFederationTokens() {
        List<String> tokens = new ArrayList<String>();
        // generate standard tokens
        for (FederationToken type : FederationToken.values()) {
            tokens.add(getFederationToken(type));
        }
        // generate tokens for federation sets
        for (String set : settings.getStrings(Keys.federation.sets)) {
            tokens.add(getFederationToken(set));
        }
        return tokens;
    }
 
    /**
     * Returns the specified federation token for this Gitblit instance.
     * 
     * @param type
     * @return a federation token
     */
    public String getFederationToken(FederationToken type) {
        return getFederationToken(type.name());
    }
 
    /**
     * Returns the specified federation token for this Gitblit instance.
     * 
     * @param value
     * @return a federation token
     */
    public String getFederationToken(String value) {
        String passphrase = settings.getString(Keys.federation.passphrase, "");
        return StringUtils.getSHA1(passphrase + "-" + value);
    }
 
    /**
     * Compares the provided token with this Gitblit instance's tokens and
     * determines if the requested permission may be granted to the token.
     * 
     * @param req
     * @param token
     * @return true if the request can be executed
     */
    public boolean validateFederationRequest(FederationRequest req, String token) {
        String all = getFederationToken(FederationToken.ALL);
        String unr = getFederationToken(FederationToken.USERS_AND_REPOSITORIES);
        String jur = getFederationToken(FederationToken.REPOSITORIES);
        switch (req) {
        case PULL_REPOSITORIES:
            return token.equals(all) || token.equals(unr) || token.equals(jur);
        case PULL_USERS:
        case PULL_TEAMS:
            return token.equals(all) || token.equals(unr);
        case PULL_SETTINGS:
            return token.equals(all);
        }
        return false;
    }
 
    /**
     * Acknowledge and cache the status of a remote Gitblit instance.
     * 
     * @param identification
     *            the identification of the pulling Gitblit instance
     * @param registration
     *            the registration from the pulling Gitblit instance
     * @return true if acknowledged
     */
    public boolean acknowledgeFederationStatus(String identification, FederationModel registration) {
        // reset the url to the identification of the pulling Gitblit instance
        registration.url = identification;
        String id = identification;
        if (!StringUtils.isEmpty(registration.folder)) {
            id += "-" + registration.folder;
        }
        federationPullResults.put(id, registration);
        return true;
    }
 
    /**
     * Returns the list of registration results.
     * 
     * @return the list of registration results
     */
    public List<FederationModel> getFederationResultRegistrations() {
        return new ArrayList<FederationModel>(federationPullResults.values());
    }
 
    /**
     * Submit a federation proposal. The proposal is cached locally and the
     * Gitblit administrator(s) are notified via email.
     * 
     * @param proposal
     *            the proposal
     * @param gitblitUrl
     *            the url of your gitblit instance to send an email to
     *            administrators
     * @return true if the proposal was submitted
     */
    public boolean submitFederationProposal(FederationProposal proposal, String gitblitUrl) {
        // convert proposal to json
        String json = JsonUtils.toJsonString(proposal);
 
        try {
            // make the proposals folder
            File proposalsFolder = getProposalsFolder();
            proposalsFolder.mkdirs();
 
            // cache json to a file
            File file = new File(proposalsFolder, proposal.token + Constants.PROPOSAL_EXT);
            com.gitblit.utils.FileUtils.writeContent(file, json);
        } catch (Exception e) {
            logger.error(MessageFormat.format("Failed to cache proposal from {0}", proposal.url), e);
        }
 
        // send an email, if possible
        try {
            Message message = mailExecutor.createMessageForAdministrators();
            if (message != null) {
                message.setSubject("Federation proposal from " + proposal.url);
                message.setText("Please review the proposal @ " + gitblitUrl + "/proposal/"
                        + proposal.token);
                mailExecutor.queue(message);
            }
        } catch (Throwable t) {
            logger.error("Failed to notify administrators of proposal", t);
        }
        return true;
    }
 
    /**
     * Returns the list of pending federation proposals
     * 
     * @return list of federation proposals
     */
    public List<FederationProposal> getPendingFederationProposals() {
        List<FederationProposal> list = new ArrayList<FederationProposal>();
        File folder = getProposalsFolder();
        if (folder.exists()) {
            File[] files = folder.listFiles(new FileFilter() {
                @Override
                public boolean accept(File file) {
                    return file.isFile()
                            && file.getName().toLowerCase().endsWith(Constants.PROPOSAL_EXT);
                }
            });
            for (File file : files) {
                String json = com.gitblit.utils.FileUtils.readContent(file, null);
                FederationProposal proposal = JsonUtils.fromJsonString(json,
                        FederationProposal.class);
                list.add(proposal);
            }
        }
        return list;
    }
 
    /**
     * Get repositories for the specified token.
     * 
     * @param gitblitUrl
     *            the base url of this gitblit instance
     * @param token
     *            the federation token
     * @return a map of <cloneurl, RepositoryModel>
     */
    public Map<String, RepositoryModel> getRepositories(String gitblitUrl, String token) {
        Map<String, String> federationSets = new HashMap<String, String>();
        for (String set : getStrings(Keys.federation.sets)) {
            federationSets.put(getFederationToken(set), set);
        }
 
        // Determine the Gitblit clone url
        StringBuilder sb = new StringBuilder();
        sb.append(gitblitUrl);
        sb.append(Constants.GIT_PATH);
        sb.append("{0}");
        String cloneUrl = sb.toString();
 
        // Retrieve all available repositories
        UserModel user = new UserModel(Constants.FEDERATION_USER);
        user.canAdmin = true;
        List<RepositoryModel> list = getRepositoryModels(user);
 
        // create the [cloneurl, repositoryModel] map
        Map<String, RepositoryModel> repositories = new HashMap<String, RepositoryModel>();
        for (RepositoryModel model : list) {
            // by default, setup the url for THIS repository
            String url = MessageFormat.format(cloneUrl, model.name);
            switch (model.federationStrategy) {
            case EXCLUDE:
                // skip this repository
                continue;
            case FEDERATE_ORIGIN:
                // federate the origin, if it is defined
                if (!StringUtils.isEmpty(model.origin)) {
                    url = model.origin;
                }
                break;
            }
 
            if (federationSets.containsKey(token)) {
                // include repositories only for federation set
                String set = federationSets.get(token);
                if (model.federationSets.contains(set)) {
                    repositories.put(url, model);
                }
            } else {
                // standard federation token for ALL
                repositories.put(url, model);
            }
        }
        return repositories;
    }
 
    /**
     * Creates a proposal from the token.
     * 
     * @param gitblitUrl
     *            the url of this Gitblit instance
     * @param token
     * @return a potential proposal
     */
    public FederationProposal createFederationProposal(String gitblitUrl, String token) {
        FederationToken tokenType = FederationToken.REPOSITORIES;
        for (FederationToken type : FederationToken.values()) {
            if (token.equals(getFederationToken(type))) {
                tokenType = type;
                break;
            }
        }
        Map<String, RepositoryModel> repositories = getRepositories(gitblitUrl, token);
        FederationProposal proposal = new FederationProposal(gitblitUrl, tokenType, token,
                repositories);
        return proposal;
    }
 
    /**
     * Returns the proposal identified by the supplied token.
     * 
     * @param token
     * @return the specified proposal or null
     */
    public FederationProposal getPendingFederationProposal(String token) {
        List<FederationProposal> list = getPendingFederationProposals();
        for (FederationProposal proposal : list) {
            if (proposal.token.equals(token)) {
                return proposal;
            }
        }
        return null;
    }
 
    /**
     * Deletes a pending federation proposal.
     * 
     * @param a
     *            proposal
     * @return true if the proposal was deleted
     */
    public boolean deletePendingFederationProposal(FederationProposal proposal) {
        File folder = getProposalsFolder();
        File file = new File(folder, proposal.token + Constants.PROPOSAL_EXT);
        return file.delete();
    }
 
    /**
     * Returns the list of all available Groovy push hook scripts that are not
     * already specified globally for all repositories. Script files must have
     * .groovy extension
     * 
     * @return list of available hook scripts
     */
    public List<String> getAvailableScripts() {
        File groovyFolder = getGroovyScriptsFolder();
        File[] files = groovyFolder.listFiles(new FileFilter() {
            @Override
            public boolean accept(File pathname) {
                return pathname.isFile() && pathname.getName().endsWith(".groovy");
            }
        });
 
        Set<String> globals = new HashSet<String>();
        String[] keys = { Keys.groovy.preReceiveScripts, Keys.groovy.postReceiveScripts };
        for (String key : keys) {
            for (String script : getStrings(key)) {
                if (script.endsWith(".groovy")) {
                    globals.add(script.substring(0, script.lastIndexOf('.')));
                } else {
                    globals.add(script);
                }
            }
        }
 
        // create list of available scripts by excluding scripts that are
        // globally specified
        List<String> scripts = new ArrayList<String>();
        if (files != null) {
            for (File file : files) {
                String script = file.getName().substring(0, file.getName().lastIndexOf('.'));
                if (!globals.contains(script)) {
                    scripts.add(script);
                }
            }
        }
        return scripts;
    }
    
    public List<String> getInheritedPreReceiveScripts(RepositoryModel repository) {
        Set<String> globals = new HashSet<String>();
        for (String script : getStrings(Keys.groovy.preReceiveScripts)) {
            if (script.endsWith(".groovy")) {
                globals.add(script.substring(0, script.lastIndexOf('.')));
            } else {
                globals.add(script);
            }
        }
        return new ArrayList<String>(globals);
    }
    
    public List<String> getInheritedPostReceiveScripts(RepositoryModel repository) {
        Set<String> globals = new HashSet<String>();
        for (String script : getStrings(Keys.groovy.postReceiveScripts)) {
            if (script.endsWith(".groovy")) {
                globals.add(script.substring(0, script.lastIndexOf('.')));
            } else {
                globals.add(script);
            }
        }
        return new ArrayList<String>(globals);
    }
 
    /**
     * Notify the administrators by email.
     * 
     * @param subject
     * @param message
     */
    public void sendMailToAdministrators(String subject, String message) {
        try {
            Message mail = mailExecutor.createMessageForAdministrators();
            if (mail != null) {
                mail.setSubject(subject);
                mail.setText(message);
                mailExecutor.queue(mail);
            }
        } catch (MessagingException e) {
            logger.error("Messaging error", e);
        }
    }
 
    /**
     * Notify users by email of something.
     * 
     * @param subject
     * @param message
     * @param toAddresses
     */
    public void sendMail(String subject, String message, Collection<String> toAddresses) {
        this.sendMail(subject, message, toAddresses.toArray(new String[0]));
    }
 
    /**
     * Notify users by email of something.
     * 
     * @param subject
     * @param message
     * @param toAddresses
     */
    public void sendMail(String subject, String message, String... toAddresses) {
        try {
            Message mail = mailExecutor.createMessage(toAddresses);
            if (mail != null) {
                mail.setSubject(subject);
                mail.setText(message);
                mailExecutor.queue(mail);
            }
        } catch (MessagingException e) {
            logger.error("Messaging error", e);
        }
    }
 
    /**
     * Returns the descriptions/comments of the Gitblit config settings.
     * 
     * @return SettingsModel
     */
    public ServerSettings getSettingsModel() {
        // ensure that the current values are updated in the setting models
        for (String key : settings.getAllKeys(null)) {
            SettingModel setting = settingsModel.get(key);
            if (setting != null) {
                setting.currentValue = settings.getString(key, "");
            }
        }
        settingsModel.pushScripts = getAvailableScripts();
        return settingsModel;
    }
 
    /**
     * Parse the properties file and aggregate all the comments by the setting
     * key. A setting model tracks the current value, the default value, the
     * description of the setting and and directives about the setting.
     * 
     * @return Map<String, SettingModel>
     */
    private ServerSettings loadSettingModels() {
        ServerSettings settingsModel = new ServerSettings();
        try {
            // Read bundled Gitblit properties to extract setting descriptions.
            // This copy is pristine and only used for populating the setting
            // models map.
            InputStream is = servletContext.getResourceAsStream("/WEB-INF/reference.properties");
            BufferedReader propertiesReader = new BufferedReader(new InputStreamReader(is));
            StringBuilder description = new StringBuilder();
            SettingModel setting = new SettingModel();
            String line = null;
            while ((line = propertiesReader.readLine()) != null) {
                if (line.length() == 0) {
                    description.setLength(0);
                    setting = new SettingModel();
                } else {
                    if (line.charAt(0) == '#') {
                        if (line.length() > 1) {
                            String text = line.substring(1).trim();
                            if (SettingModel.CASE_SENSITIVE.equals(text)) {
                                setting.caseSensitive = true;
                            } else if (SettingModel.RESTART_REQUIRED.equals(text)) {
                                setting.restartRequired = true;
                            } else if (SettingModel.SPACE_DELIMITED.equals(text)) {
                                setting.spaceDelimited = true;
                            } else if (text.startsWith(SettingModel.SINCE)) {
                                try {
                                    setting.since = text.split(" ")[1];
                                } catch (Exception e) {
                                    setting.since = text;
                                }
                            } else {
                                description.append(text);
                                description.append('\n');
                            }
                        }
                    } else {
                        String[] kvp = line.split("=", 2);
                        String key = kvp[0].trim();
                        setting.name = key;
                        setting.defaultValue = kvp[1].trim();
                        setting.currentValue = setting.defaultValue;
                        setting.description = description.toString().trim();
                        settingsModel.add(setting);
                        description.setLength(0);
                        setting = new SettingModel();
                    }
                }
            }
            propertiesReader.close();
        } catch (NullPointerException e) {
            logger.error("Failed to find resource copy of gitblit.properties");
        } catch (IOException e) {
            logger.error("Failed to load resource copy of gitblit.properties");
        }
        return settingsModel;
    }
 
    /**
     * Configure the Gitblit singleton with the specified settings source. This
     * source may be file settings (Gitblit GO) or may be web.xml settings
     * (Gitblit WAR).
     * 
     * @param settings
     */
    public void configureContext(IStoredSettings settings, boolean startFederation) {
        logger.info("Reading configuration from " + settings.toString());
        this.settings = settings;
        repositoriesFolder = getRepositoriesFolder();
        logger.info("Git repositories folder " + repositoriesFolder.getAbsolutePath());
        repositoryResolver = new FileResolver<Void>(repositoriesFolder, exportAll);
        serverStatus = new ServerStatus(isGO());
        String realm = settings.getString(Keys.realm.userService, "users.properties");
        IUserService loginService = null;
        try {
            // check to see if this "file" is a login service class
            Class<?> realmClass = Class.forName(realm);
            if (IUserService.class.isAssignableFrom(realmClass)) {
                loginService = (IUserService) realmClass.newInstance();
            }
        } catch (Throwable t) {
            loginService = new GitblitUserService();
        }
        setUserService(loginService);
        mailExecutor = new MailExecutor(settings);
        if (mailExecutor.isReady()) {
            scheduledExecutor.scheduleAtFixedRate(mailExecutor, 1, 2, TimeUnit.MINUTES);
        } else {
            logger.warn("Mail server is not properly configured.  Mail services disabled.");
        }
        if (startFederation) {
            configureFederation();
        }
    }
 
    /**
     * Configure Gitblit from the web.xml, if no configuration has already been
     * specified.
     * 
     * @see ServletContextListener.contextInitialize(ServletContextEvent)
     */
    @Override
    public void contextInitialized(ServletContextEvent contextEvent) {
        servletContext = contextEvent.getServletContext();
        settingsModel = loadSettingModels();
        if (settings == null) {
            // Gitblit WAR is running in a servlet container
            ServletContext context = contextEvent.getServletContext();
            WebXmlSettings webxmlSettings = new WebXmlSettings(context);
 
            // 0.7.0 web.properties in the deployed war folder
            File overrideFile = new File(context.getRealPath("/WEB-INF/web.properties"));
            if (overrideFile.exists()) {
                webxmlSettings.applyOverrides(overrideFile);
            }
 
            // 0.8.0 gitblit.properties file located outside the deployed war
            // folder lie, for example, on RedHat OpenShift.
            overrideFile = getFileOrFolder("gitblit.properties");
            if (!overrideFile.getPath().equals("gitblit.properties")) {
                webxmlSettings.applyOverrides(overrideFile);
            }
            configureContext(webxmlSettings, true);
        }
 
        serverStatus.servletContainer = servletContext.getServerInfo();
    }
 
    /**
     * Gitblit is being shutdown either because the servlet container is
     * shutting down or because the servlet container is re-deploying Gitblit.
     */
    @Override
    public void contextDestroyed(ServletContextEvent contextEvent) {
        logger.info("Gitblit context destroyed by servlet container.");
        scheduledExecutor.shutdownNow();
    }
}