+                                        <th>KPI</th>
47 48 
                                     </tr>
48 49 
                                 </thead>
49 50 
                                 <tfoot>
@@ -56,6 +57,7 @@
56 57 
                                         <th>Close date</th>
57 58 
                                         <th>SOC Ticket</th>
58 59 
                                         <th>Opening user</th>
60 
+                                        <th>KPI</th>
59 61 
                                     </tr>
60 62 
                                 </tfoot>
61 63 
                             </table>

+ 6 - 0
iris-web/source/app/templates/includes/sidenav.html
Näytä tiedosto 

@@ -101,6 +101,12 @@
101 101 
 								<span>DIM Tasks</span>
102 102 
 							</a>
103 103 
 						</li>
104 
+						<li class="nav-item">
105 
+							<a href="/kpi-dashboard">
106 
+								<i class="fas fa-tachometer-alt"></i>
107 
+								<span>KPI Dashboard</span>
108 
+							</a>
109 
+						</li>
104 110
105 111
106 112 
 						<li class="nav-section nav-advanced">

+ 3 - 0
iris-web/source/app/views.py
Näytä tiedosto 

@@ -97,6 +97,7 @@ from app.blueprints.rest.search_routes import search_rest_blueprint
97 97 
 from app.blueprints.graphql.graphql_route import graphql_blueprint
98 98
99 99 
 from app.blueprints.rest.v2 import rest_v2_blueprint
100 
+from app.blueprints.pages.kpi_dashboard.kpi_dashboard_routes import kpi_dashboard_blueprint
100 101 
 from app.models.authorization import User
101 102
102 103 
 def register_blusprints(app):
 
@@ -183,6 +184,8 @@ def register_blusprints(app):
183 184
184 185 
     app.register_blueprint(rest_v2_blueprint)
185 186
187 
+    app.register_blueprint(kpi_dashboard_blueprint)
188 
+
186 189
187 190
188 191 
 # provide login manager with load_user callback

+ 199 - 91
iris-web/ui/package-lock.json
Näytä tiedosto 

@@ -21,6 +21,7 @@
21 21 
         "jquery.scrollbar": "^0.2.10",
22 22 
         "jqvmap": "^1.5.1",
23 23 
         "moment": "^2.22.2",
24 
+        "rollup": "^4.59.0",
24 25 
         "showdown": "^1.9.0",
25 26 
         "socket.io": "^4.3.2",
26 27 
         "sortablejs": "^1.7.0",
 
@@ -842,13 +843,12 @@
842 843 
       }
843 844 
     },
844 845 
     "node_modules/@rollup/rollup-android-arm-eabi": {
845 
-      "version": "4.22.5",
846 
-      "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm-eabi/-/rollup-android-arm-eabi-4.22.5.tgz",
847 
-      "integrity": "sha512-SU5cvamg0Eyu/F+kLeMXS7GoahL+OoizlclVFX3l5Ql6yNlywJJ0OuqTzUx0v+aHhPHEB/56CT06GQrRrGNYww==",
846 
+      "version": "4.59.0",
847 
+      "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm-eabi/-/rollup-android-arm-eabi-4.59.0.tgz",
848 
+      "integrity": "sha512-upnNBkA6ZH2VKGcBj9Fyl9IGNPULcjXRlg0LLeaioQWueH30p6IXtJEbKAgvyv+mJaMxSm1l6xwDXYjpEMiLMg==",
848 849 
       "cpu": [
849 850 
         "arm"
850 851 
       ],
851 
-      "dev": true,
852 852 
       "license": "MIT",
853 853 
       "optional": true,
854 854 
       "os": [
 
@@ -856,13 +856,12 @@
856 856 
       ]
857 857 
     },
858 858 
     "node_modules/@rollup/rollup-android-arm64": {
859 
-      "version": "4.22.5",
860 
-      "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm64/-/rollup-android-arm64-4.22.5.tgz",
861 
-      "integrity": "sha512-S4pit5BP6E5R5C8S6tgU/drvgjtYW76FBuG6+ibG3tMvlD1h9LHVF9KmlmaUBQ8Obou7hEyS+0w+IR/VtxwNMQ==",
859 
+      "version": "4.59.0",
860 
+      "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm64/-/rollup-android-arm64-4.59.0.tgz",
861 
+      "integrity": "sha512-hZ+Zxj3SySm4A/DylsDKZAeVg0mvi++0PYVceVyX7hemkw7OreKdCvW2oQ3T1FMZvCaQXqOTHb8qmBShoqk69Q==",
862 862 
       "cpu": [
863 863 
         "arm64"
864 864 
       ],
865 
-      "dev": true,
866 865 
       "license": "MIT",
867 866 
       "optional": true,
868 867 
       "os": [
 
@@ -870,13 +869,12 @@
870 869 
       ]
871 870 
     },
872 871 
     "node_modules/@rollup/rollup-darwin-arm64": {
873 
-      "version": "4.22.5",
874 
-      "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-arm64/-/rollup-darwin-arm64-4.22.5.tgz",
875 
-      "integrity": "sha512-250ZGg4ipTL0TGvLlfACkIxS9+KLtIbn7BCZjsZj88zSg2Lvu3Xdw6dhAhfe/FjjXPVNCtcSp+WZjVsD3a/Zlw==",
872 
+      "version": "4.59.0",
873 
+      "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-arm64/-/rollup-darwin-arm64-4.59.0.tgz",
874 
+      "integrity": "sha512-W2Psnbh1J8ZJw0xKAd8zdNgF9HRLkdWwwdWqubSVk0pUuQkoHnv7rx4GiF9rT4t5DIZGAsConRE3AxCdJ4m8rg==",
876 875 
       "cpu": [
877 876 
         "arm64"
878 877 
       ],
879 
-      "dev": true,
880 878 
       "license": "MIT",
881 879 
       "optional": true,
882 880 
       "os": [
 
@@ -884,27 +882,51 @@
884 882 
       ]
885 883 
     },
886 884 
     "node_modules/@rollup/rollup-darwin-x64": {
887 
-      "version": "4.22.5",
888 
-      "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-x64/-/rollup-darwin-x64-4.22.5.tgz",
889 
-      "integrity": "sha512-D8brJEFg5D+QxFcW6jYANu+Rr9SlKtTenmsX5hOSzNYVrK5oLAEMTUgKWYJP+wdKyCdeSwnapLsn+OVRFycuQg==",
885 
+      "version": "4.59.0",
886 
+      "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-x64/-/rollup-darwin-x64-4.59.0.tgz",
887 
+      "integrity": "sha512-ZW2KkwlS4lwTv7ZVsYDiARfFCnSGhzYPdiOU4IM2fDbL+QGlyAbjgSFuqNRbSthybLbIJ915UtZBtmuLrQAT/w==",
890 888 
       "cpu": [
891 889 
         "x64"
892 890 
       ],
893 
-      "dev": true,
894 891 
       "license": "MIT",
895 892 
       "optional": true,
896 893 
       "os": [
897 894 
         "darwin"
898 895 
       ]
899 896 
     },
897 
+    "node_modules/@rollup/rollup-freebsd-arm64": {
898 
+      "version": "4.59.0",
899 
+      "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-arm64/-/rollup-freebsd-arm64-4.59.0.tgz",
900 
+      "integrity": "sha512-EsKaJ5ytAu9jI3lonzn3BgG8iRBjV4LxZexygcQbpiU0wU0ATxhNVEpXKfUa0pS05gTcSDMKpn3Sx+QB9RlTTA==",
901 
+      "cpu": [
902 
+        "arm64"
903 
+      ],
904 
+      "license": "MIT",
905 
+      "optional": true,
906 
+      "os": [
907 
+        "freebsd"
908 
+      ]
909 
+    },
910 
+    "node_modules/@rollup/rollup-freebsd-x64": {
911 
+      "version": "4.59.0",
912 
+      "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-x64/-/rollup-freebsd-x64-4.59.0.tgz",
913 
+      "integrity": "sha512-d3DuZi2KzTMjImrxoHIAODUZYoUUMsuUiY4SRRcJy6NJoZ6iIqWnJu9IScV9jXysyGMVuW+KNzZvBLOcpdl3Vg==",
914 
+      "cpu": [
915 
+        "x64"
916 
+      ],
917 
+      "license": "MIT",
918 
+      "optional": true,
919 
+      "os": [
920 
+        "freebsd"
921 
+      ]
922 
+    },
900 923 
     "node_modules/@rollup/rollup-linux-arm-gnueabihf": {
901 
-      "version": "4.22.5",
902 
-      "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-gnueabihf/-/rollup-linux-arm-gnueabihf-4.22.5.tgz",
903 
-      "integrity": "sha512-PNqXYmdNFyWNg0ma5LdY8wP+eQfdvyaBAojAXgO7/gs0Q/6TQJVXAXe8gwW9URjbS0YAammur0fynYGiWsKlXw==",
924 
+      "version": "4.59.0",
925 
+      "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-gnueabihf/-/rollup-linux-arm-gnueabihf-4.59.0.tgz",
926 
+      "integrity": "sha512-t4ONHboXi/3E0rT6OZl1pKbl2Vgxf9vJfWgmUoCEVQVxhW6Cw/c8I6hbbu7DAvgp82RKiH7TpLwxnJeKv2pbsw==",
904 927 
       "cpu": [
905 928 
         "arm"
906 929 
       ],
907 
-      "dev": true,
908 930 
       "license": "MIT",
909 931 
       "optional": true,
910 932 
       "os": [
 
@@ -912,13 +934,12 @@
912 934 
       ]
913 935 
     },
914 936 
     "node_modules/@rollup/rollup-linux-arm-musleabihf": {
915 
-      "version": "4.22.5",
916 
-      "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-musleabihf/-/rollup-linux-arm-musleabihf-4.22.5.tgz",
917 
-      "integrity": "sha512-kSSCZOKz3HqlrEuwKd9TYv7vxPYD77vHSUvM2y0YaTGnFc8AdI5TTQRrM1yIp3tXCKrSL9A7JLoILjtad5t8pQ==",
937 
+      "version": "4.59.0",
938 
+      "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-musleabihf/-/rollup-linux-arm-musleabihf-4.59.0.tgz",
939 
+      "integrity": "sha512-CikFT7aYPA2ufMD086cVORBYGHffBo4K8MQ4uPS/ZnY54GKj36i196u8U+aDVT2LX4eSMbyHtyOh7D7Zvk2VvA==",
918 940 
       "cpu": [
919 941 
         "arm"
920 942 
       ],
921 
-      "dev": true,
922 943 
       "license": "MIT",
923 944 
       "optional": true,
924 945 
       "os": [
 
@@ -926,13 +947,12 @@
926 947 
       ]
927 948 
     },
928 949 
     "node_modules/@rollup/rollup-linux-arm64-gnu": {
929 
-      "version": "4.22.5",
930 
-      "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-gnu/-/rollup-linux-arm64-gnu-4.22.5.tgz",
931 
-      "integrity": "sha512-oTXQeJHRbOnwRnRffb6bmqmUugz0glXaPyspp4gbQOPVApdpRrY/j7KP3lr7M8kTfQTyrBUzFjj5EuHAhqH4/w==",
950 
+      "version": "4.59.0",
951 
+      "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-gnu/-/rollup-linux-arm64-gnu-4.59.0.tgz",
952 
+      "integrity": "sha512-jYgUGk5aLd1nUb1CtQ8E+t5JhLc9x5WdBKew9ZgAXg7DBk0ZHErLHdXM24rfX+bKrFe+Xp5YuJo54I5HFjGDAA==",
932 953 
       "cpu": [
933 954 
         "arm64"
934 955 
       ],
935 
-      "dev": true,
936 956 
       "license": "MIT",
937 957 
       "optional": true,
938 958 
       "os": [
 
@@ -940,27 +960,64 @@
940 960 
       ]
941 961 
     },
942 962 
     "node_modules/@rollup/rollup-linux-arm64-musl": {
943 
-      "version": "4.22.5",
944 
-      "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-musl/-/rollup-linux-arm64-musl-4.22.5.tgz",
945 
-      "integrity": "sha512-qnOTIIs6tIGFKCHdhYitgC2XQ2X25InIbZFor5wh+mALH84qnFHvc+vmWUpyX97B0hNvwNUL4B+MB8vJvH65Fw==",
963 
+      "version": "4.59.0",
964 
+      "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-musl/-/rollup-linux-arm64-musl-4.59.0.tgz",
965 
+      "integrity": "sha512-peZRVEdnFWZ5Bh2KeumKG9ty7aCXzzEsHShOZEFiCQlDEepP1dpUl/SrUNXNg13UmZl+gzVDPsiCwnV1uI0RUA==",
946 966 
       "cpu": [
947 967 
         "arm64"
948 968 
       ],
949 
-      "dev": true,
950 969 
       "license": "MIT",
951 970 
       "optional": true,
952 971 
       "os": [
953 972 
         "linux"
954 973 
       ]
955 974 
     },
956 
-    "node_modules/@rollup/rollup-linux-powerpc64le-gnu": {
957 
-      "version": "4.22.5",
958 
-      "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-powerpc64le-gnu/-/rollup-linux-powerpc64le-gnu-4.22.5.tgz",
959 
-      "integrity": "sha512-TMYu+DUdNlgBXING13rHSfUc3Ky5nLPbWs4bFnT+R6Vu3OvXkTkixvvBKk8uO4MT5Ab6lC3U7x8S8El2q5o56w==",
975 
+    "node_modules/@rollup/rollup-linux-loong64-gnu": {
976 
+      "version": "4.59.0",
977 
+      "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-loong64-gnu/-/rollup-linux-loong64-gnu-4.59.0.tgz",
978 
+      "integrity": "sha512-gbUSW/97f7+r4gHy3Jlup8zDG190AuodsWnNiXErp9mT90iCy9NKKU0Xwx5k8VlRAIV2uU9CsMnEFg/xXaOfXg==",
979 
+      "cpu": [
980 
+        "loong64"
981 
+      ],
982 
+      "license": "MIT",
983 
+      "optional": true,
984 
+      "os": [
985 
+        "linux"
986 
+      ]
987 
+    },
988 
+    "node_modules/@rollup/rollup-linux-loong64-musl": {
989 
+      "version": "4.59.0",
990 
+      "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-loong64-musl/-/rollup-linux-loong64-musl-4.59.0.tgz",
991 
+      "integrity": "sha512-yTRONe79E+o0FWFijasoTjtzG9EBedFXJMl888NBEDCDV9I2wGbFFfJQQe63OijbFCUZqxpHz1GzpbtSFikJ4Q==",
992 
+      "cpu": [
993 
+        "loong64"
994 
+      ],
995 
+      "license": "MIT",
996 
+      "optional": true,
997 
+      "os": [
998 
+        "linux"
999 
+      ]
1000 
+    },
1001 
+    "node_modules/@rollup/rollup-linux-ppc64-gnu": {
1002 
+      "version": "4.59.0",
1003 
+      "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-ppc64-gnu/-/rollup-linux-ppc64-gnu-4.59.0.tgz",
1004 
+      "integrity": "sha512-sw1o3tfyk12k3OEpRddF68a1unZ5VCN7zoTNtSn2KndUE+ea3m3ROOKRCZxEpmT9nsGnogpFP9x6mnLTCaoLkA==",
1005 
+      "cpu": [
1006 
+        "ppc64"
1007 
+      ],
1008 
+      "license": "MIT",
1009 
+      "optional": true,
1010 
+      "os": [
1011 
+        "linux"
1012 
+      ]
1013 
+    },
1014 
+    "node_modules/@rollup/rollup-linux-ppc64-musl": {
1015 
+      "version": "4.59.0",
1016 
+      "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-ppc64-musl/-/rollup-linux-ppc64-musl-4.59.0.tgz",
1017 
+      "integrity": "sha512-+2kLtQ4xT3AiIxkzFVFXfsmlZiG5FXYW7ZyIIvGA7Bdeuh9Z0aN4hVyXS/G1E9bTP/vqszNIN/pUKCk/BTHsKA==",
960 1018 
       "cpu": [
961 1019 
         "ppc64"
962 1020 
       ],
963 
-      "dev": true,
964 1021 
       "license": "MIT",
965 1022 
       "optional": true,
966 1023 
       "os": [
 
@@ -968,13 +1025,25 @@
968 1025 
       ]
969 1026 
     },
970 1027 
     "node_modules/@rollup/rollup-linux-riscv64-gnu": {
971 
-      "version": "4.22.5",
972 
-      "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-gnu/-/rollup-linux-riscv64-gnu-4.22.5.tgz",
973 
-      "integrity": "sha512-PTQq1Kz22ZRvuhr3uURH+U/Q/a0pbxJoICGSprNLAoBEkyD3Sh9qP5I0Asn0y0wejXQBbsVMRZRxlbGFD9OK4A==",
1028 
+      "version": "4.59.0",
1029 
+      "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-gnu/-/rollup-linux-riscv64-gnu-4.59.0.tgz",
1030 
+      "integrity": "sha512-NDYMpsXYJJaj+I7UdwIuHHNxXZ/b/N2hR15NyH3m2qAtb/hHPA4g4SuuvrdxetTdndfj9b1WOmy73kcPRoERUg==",
1031 
+      "cpu": [
1032 
+        "riscv64"
1033 
+      ],
1034 
+      "license": "MIT",
1035 
+      "optional": true,
1036 
+      "os": [
1037 
+        "linux"
1038 
+      ]
1039 
+    },
1040 
+    "node_modules/@rollup/rollup-linux-riscv64-musl": {
1041 
+      "version": "4.59.0",
1042 
+      "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-musl/-/rollup-linux-riscv64-musl-4.59.0.tgz",
1043 
+      "integrity": "sha512-nLckB8WOqHIf1bhymk+oHxvM9D3tyPndZH8i8+35p/1YiVoVswPid2yLzgX7ZJP0KQvnkhM4H6QZ5m0LzbyIAg==",
974 1044 
       "cpu": [
975 1045 
         "riscv64"
976 1046 
       ],
977 
-      "dev": true,
978 1047 
       "license": "MIT",
979 1048 
       "optional": true,
980 1049 
       "os": [
 
@@ -982,13 +1051,12 @@
982 1051 
       ]
983 1052 
     },
984 1053 
     "node_modules/@rollup/rollup-linux-s390x-gnu": {
985 
-      "version": "4.22.5",
986 
-      "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-s390x-gnu/-/rollup-linux-s390x-gnu-4.22.5.tgz",
987 
-      "integrity": "sha512-bR5nCojtpuMss6TDEmf/jnBnzlo+6n1UhgwqUvRoe4VIotC7FG1IKkyJbwsT7JDsF2jxR+NTnuOwiGv0hLyDoQ==",
1054 
+      "version": "4.59.0",
1055 
+      "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-s390x-gnu/-/rollup-linux-s390x-gnu-4.59.0.tgz",
1056 
+      "integrity": "sha512-oF87Ie3uAIvORFBpwnCvUzdeYUqi2wY6jRFWJAy1qus/udHFYIkplYRW+wo+GRUP4sKzYdmE1Y3+rY5Gc4ZO+w==",
988 1057 
       "cpu": [
989 1058 
         "s390x"
990 1059 
       ],
991 
-      "dev": true,
992 1060 
       "license": "MIT",
993 1061 
       "optional": true,
994 1062 
       "os": [
 
@@ -996,13 +1064,12 @@
996 1064 
       ]
997 1065 
     },
998 1066 
     "node_modules/@rollup/rollup-linux-x64-gnu": {
999 
-      "version": "4.22.5",
1000 
-      "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-gnu/-/rollup-linux-x64-gnu-4.22.5.tgz",
1001 
-      "integrity": "sha512-N0jPPhHjGShcB9/XXZQWuWBKZQnC1F36Ce3sDqWpujsGjDz/CQtOL9LgTrJ+rJC8MJeesMWrMWVLKKNR/tMOCA==",
1067 
+      "version": "4.59.0",
1068 
+      "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-gnu/-/rollup-linux-x64-gnu-4.59.0.tgz",
1069 
+      "integrity": "sha512-3AHmtQq/ppNuUspKAlvA8HtLybkDflkMuLK4DPo77DfthRb71V84/c4MlWJXixZz4uruIH4uaa07IqoAkG64fg==",
1002 1070 
       "cpu": [
1003 1071 
         "x64"
1004 1072 
       ],
1005 
-      "dev": true,
1006 1073 
       "license": "MIT",
1007 1074 
       "optional": true,
1008 1075 
       "os": [
 
@@ -1010,27 +1077,51 @@
1010 1077 
       ]
1011 1078 
     },
1012 1079 
     "node_modules/@rollup/rollup-linux-x64-musl": {
1013 
-      "version": "4.22.5",
1014 
-      "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-musl/-/rollup-linux-x64-musl-4.22.5.tgz",
1015 
-      "integrity": "sha512-uBa2e28ohzNNwjr6Uxm4XyaA1M/8aTgfF2T7UIlElLaeXkgpmIJ2EitVNQxjO9xLLLy60YqAgKn/AqSpCUkE9g==",
1080 
+      "version": "4.59.0",
1081 
+      "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-musl/-/rollup-linux-x64-musl-4.59.0.tgz",
1082 
+      "integrity": "sha512-2UdiwS/9cTAx7qIUZB/fWtToJwvt0Vbo0zmnYt7ED35KPg13Q0ym1g442THLC7VyI6JfYTP4PiSOWyoMdV2/xg==",
1016 1083 
       "cpu": [
1017 1084 
         "x64"
1018 1085 
       ],
1019 
-      "dev": true,
1020 1086 
       "license": "MIT",
1021 1087 
       "optional": true,
1022 1088 
       "os": [
1023 1089 
         "linux"
1024 1090 
       ]
1025 1091 
     },
1092 
+    "node_modules/@rollup/rollup-openbsd-x64": {
1093 
+      "version": "4.59.0",
1094 
+      "resolved": "https://registry.npmjs.org/@rollup/rollup-openbsd-x64/-/rollup-openbsd-x64-4.59.0.tgz",
1095 
+      "integrity": "sha512-M3bLRAVk6GOwFlPTIxVBSYKUaqfLrn8l0psKinkCFxl4lQvOSz8ZrKDz2gxcBwHFpci0B6rttydI4IpS4IS/jQ==",
1096 
+      "cpu": [
1097 
+        "x64"
1098 
+      ],
1099 
+      "license": "MIT",
1100 
+      "optional": true,
1101 
+      "os": [
1102 
+        "openbsd"
1103 
+      ]
1104 
+    },
1105 
+    "node_modules/@rollup/rollup-openharmony-arm64": {
1106 
+      "version": "4.59.0",
1107 
+      "resolved": "https://registry.npmjs.org/@rollup/rollup-openharmony-arm64/-/rollup-openharmony-arm64-4.59.0.tgz",
1108 
+      "integrity": "sha512-tt9KBJqaqp5i5HUZzoafHZX8b5Q2Fe7UjYERADll83O4fGqJ49O1FsL6LpdzVFQcpwvnyd0i+K/VSwu/o/nWlA==",
1109 
+      "cpu": [
1110 
+        "arm64"
1111 
+      ],
1112 
+      "license": "MIT",
1113 
+      "optional": true,
1114 
+      "os": [
1115 
+        "openharmony"
1116 
+      ]
1117 
+    },
1026 1118 
     "node_modules/@rollup/rollup-win32-arm64-msvc": {
1027 
-      "version": "4.22.5",
1028 
-      "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-arm64-msvc/-/rollup-win32-arm64-msvc-4.22.5.tgz",
1029 
-      "integrity": "sha512-RXT8S1HP8AFN/Kr3tg4fuYrNxZ/pZf1HemC5Tsddc6HzgGnJm0+Lh5rAHJkDuW3StI0ynNXukidROMXYl6ew8w==",
1119 
+      "version": "4.59.0",
1120 
+      "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-arm64-msvc/-/rollup-win32-arm64-msvc-4.59.0.tgz",
1121 
+      "integrity": "sha512-V5B6mG7OrGTwnxaNUzZTDTjDS7F75PO1ae6MJYdiMu60sq0CqN5CVeVsbhPxalupvTX8gXVSU9gq+Rx1/hvu6A==",
1030 1122 
       "cpu": [
1031 1123 
         "arm64"
1032 1124 
       ],
1033 
-      "dev": true,
1034 1125 
       "license": "MIT",
1035 1126 
       "optional": true,
1036 1127 
       "os": [
 
@@ -1038,13 +1129,25 @@
1038 1129 
       ]
1039 1130 
     },
1040 1131 
     "node_modules/@rollup/rollup-win32-ia32-msvc": {
1041 
-      "version": "4.22.5",
1042 
-      "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-ia32-msvc/-/rollup-win32-ia32-msvc-4.22.5.tgz",
1043 
-      "integrity": "sha512-ElTYOh50InL8kzyUD6XsnPit7jYCKrphmddKAe1/Ytt74apOxDq5YEcbsiKs0fR3vff3jEneMM+3I7jbqaMyBg==",
1132 
+      "version": "4.59.0",
1133 
+      "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-ia32-msvc/-/rollup-win32-ia32-msvc-4.59.0.tgz",
1134 
+      "integrity": "sha512-UKFMHPuM9R0iBegwzKF4y0C4J9u8C6MEJgFuXTBerMk7EJ92GFVFYBfOZaSGLu6COf7FxpQNqhNS4c4icUPqxA==",
1044 1135 
       "cpu": [
1045 1136 
         "ia32"
1046 1137 
       ],
1047 
-      "dev": true,
1138 
+      "license": "MIT",
1139 
+      "optional": true,
1140 
+      "os": [
1141 
+        "win32"
1142 
+      ]
1143 
+    },
1144 
+    "node_modules/@rollup/rollup-win32-x64-gnu": {
1145 
+      "version": "4.59.0",
1146 
+      "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-gnu/-/rollup-win32-x64-gnu-4.59.0.tgz",
1147 
+      "integrity": "sha512-laBkYlSS1n2L8fSo1thDNGrCTQMmxjYY5G0WFWjFFYZkKPjsMBsgJfGf4TLxXrF6RyhI60L8TMOjBMvXiTcxeA==",
1148 
+      "cpu": [
1149 
+        "x64"
1150 
+      ],
1048 1151 
       "license": "MIT",
1049 1152 
       "optional": true,
1050 1153 
       "os": [
 
@@ -1052,13 +1155,12 @@
1052 1155 
       ]
1053 1156 
     },
1054 1157 
     "node_modules/@rollup/rollup-win32-x64-msvc": {
1055 
-      "version": "4.22.5",
1056 
-      "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-msvc/-/rollup-win32-x64-msvc-4.22.5.tgz",
1057 
-      "integrity": "sha512-+lvL/4mQxSV8MukpkKyyvfwhH266COcWlXE/1qxwN08ajovta3459zrjLghYMgDerlzNwLAcFpvU+WWE5y6nAQ==",
1158 
+      "version": "4.59.0",
1159 
+      "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-msvc/-/rollup-win32-x64-msvc-4.59.0.tgz",
1160 
+      "integrity": "sha512-2HRCml6OztYXyJXAvdDXPKcawukWY2GpR5/nxKp4iBgiO3wcoEGkAaqctIbZcNB6KlUQBIqt8VYkNSj2397EfA==",
1058 1161 
       "cpu": [
1059 1162 
         "x64"
1060 1163 
       ],
1061 
-      "dev": true,
1062 1164 
       "license": "MIT",
1063 1165 
       "optional": true,
1064 1166 
       "os": [
 
@@ -1122,10 +1224,9 @@
1122 1224 
       }
1123 1225 
     },
1124 1226 
     "node_modules/@types/estree": {
1125 
-      "version": "1.0.6",
1126 
-      "resolved": "https://registry.npmjs.org/@types/estree/-/estree-1.0.6.tgz",
1127 
-      "integrity": "sha512-AYnb1nQyY49te+VRAVgmzfcgjYS91mY5P0TKUDCLEM+gNnA+3T6rWITXRLYCpahpqSQbN5cE+gHpnPyXjHWxcw==",
1128 
-      "dev": true,
1227 
+      "version": "1.0.8",
1228 
+      "resolved": "https://registry.npmjs.org/@types/estree/-/estree-1.0.8.tgz",
1229 
+      "integrity": "sha512-dWHzHa2WqEXI/O1E9OjrocMTKJl2mSrEolh1Iomrv6U+JuNwaHXsXx9bLu5gG7BUWFIN0skIQJQ/L1rIex4X6w==",
1129 1230 
       "license": "MIT"
1130 1231 
     },
1131 1232 
     "node_modules/@types/jquery": {
 
@@ -2341,7 +2442,6 @@
2341 2442 
       "version": "2.3.3",
2342 2443 
       "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.3.tgz",
2343 2444 
       "integrity": "sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw==",
2344 
-      "dev": true,
2345 2445 
       "hasInstallScript": true,
2346 2446 
       "license": "MIT",
2347 2447 
       "optional": true,
 
@@ -3553,13 +3653,12 @@
3553 3653 
       }
3554 3654 
     },
3555 3655 
     "node_modules/rollup": {
3556 
-      "version": "4.22.5",
3557 
-      "resolved": "https://registry.npmjs.org/rollup/-/rollup-4.22.5.tgz",
3558 
-      "integrity": "sha512-WoinX7GeQOFMGznEcWA1WrTQCd/tpEbMkc3nuMs9BT0CPjMdSjPMTVClwWd4pgSQwJdP65SK9mTCNvItlr5o7w==",
3559 
-      "dev": true,
3656 
+      "version": "4.59.0",
3657 
+      "resolved": "https://registry.npmjs.org/rollup/-/rollup-4.59.0.tgz",
3658 
+      "integrity": "sha512-2oMpl67a3zCH9H79LeMcbDhXW/UmWG/y2zuqnF2jQq5uq9TbM9TVyXvA4+t+ne2IIkBdrLpAaRQAvo7YI/Yyeg==",
3560 3659 
       "license": "MIT",
3561 3660 
       "dependencies": {
3562 
-        "@types/estree": "1.0.6"
3661 
+        "@types/estree": "1.0.8"
3563 3662 
       },
3564 3663 
       "bin": {
3565 3664 
         "rollup": "dist/bin/rollup"
 
@@ -3569,22 +3668,31 @@
3569 3668 
         "npm": ">=8.0.0"
3570 3669 
       },
3571 3670 
       "optionalDependencies": {
3572 
-        "@rollup/rollup-android-arm-eabi": "4.22.5",
3573 
-        "@rollup/rollup-android-arm64": "4.22.5",
3574 
-        "@rollup/rollup-darwin-arm64": "4.22.5",
3575 
-        "@rollup/rollup-darwin-x64": "4.22.5",
3576 
-        "@rollup/rollup-linux-arm-gnueabihf": "4.22.5",
3577 
-        "@rollup/rollup-linux-arm-musleabihf": "4.22.5",
3578 
-        "@rollup/rollup-linux-arm64-gnu": "4.22.5",
3579 
-        "@rollup/rollup-linux-arm64-musl": "4.22.5",
3580 
-        "@rollup/rollup-linux-powerpc64le-gnu": "4.22.5",
3581 
-        "@rollup/rollup-linux-riscv64-gnu": "4.22.5",
3582 
-        "@rollup/rollup-linux-s390x-gnu": "4.22.5",
3583 
-        "@rollup/rollup-linux-x64-gnu": "4.22.5",
3584 
-        "@rollup/rollup-linux-x64-musl": "4.22.5",
3585 
-        "@rollup/rollup-win32-arm64-msvc": "4.22.5",
3586 
-        "@rollup/rollup-win32-ia32-msvc": "4.22.5",
3587 
-        "@rollup/rollup-win32-x64-msvc": "4.22.5",
3671 
+        "@rollup/rollup-android-arm-eabi": "4.59.0",
3672 
+        "@rollup/rollup-android-arm64": "4.59.0",
3673 
+        "@rollup/rollup-darwin-arm64": "4.59.0",
3674 
+        "@rollup/rollup-darwin-x64": "4.59.0",
3675 
+        "@rollup/rollup-freebsd-arm64": "4.59.0",
3676 
+        "@rollup/rollup-freebsd-x64": "4.59.0",
3677 
+        "@rollup/rollup-linux-arm-gnueabihf": "4.59.0",
3678 
+        "@rollup/rollup-linux-arm-musleabihf": "4.59.0",
3679 
+        "@rollup/rollup-linux-arm64-gnu": "4.59.0",
3680 
+        "@rollup/rollup-linux-arm64-musl": "4.59.0",
3681 
+        "@rollup/rollup-linux-loong64-gnu": "4.59.0",
3682 
+        "@rollup/rollup-linux-loong64-musl": "4.59.0",
3683 
+        "@rollup/rollup-linux-ppc64-gnu": "4.59.0",
3684 
+        "@rollup/rollup-linux-ppc64-musl": "4.59.0",
3685 
+        "@rollup/rollup-linux-riscv64-gnu": "4.59.0",
3686 
+        "@rollup/rollup-linux-riscv64-musl": "4.59.0",
3687 
+        "@rollup/rollup-linux-s390x-gnu": "4.59.0",
3688 
+        "@rollup/rollup-linux-x64-gnu": "4.59.0",
3689 
+        "@rollup/rollup-linux-x64-musl": "4.59.0",
3690 
+        "@rollup/rollup-openbsd-x64": "4.59.0",
3691 
+        "@rollup/rollup-openharmony-arm64": "4.59.0",
3692 
+        "@rollup/rollup-win32-arm64-msvc": "4.59.0",
3693 
+        "@rollup/rollup-win32-ia32-msvc": "4.59.0",
3694 
+        "@rollup/rollup-win32-x64-gnu": "4.59.0",
3695 
+        "@rollup/rollup-win32-x64-msvc": "4.59.0",
3588 3696 
         "fsevents": "~2.3.2"
3589 3697 
       }
3590 3698 
     },

+ 1 - 0
iris-web/ui/package.json
Näytä tiedosto 

@@ -37,6 +37,7 @@
37 37 
     "jquery.scrollbar": "^0.2.10",
38 38 
     "jqvmap": "^1.5.1",
39 39 
     "moment": "^2.22.2",
40 
+    "rollup": "^4.59.0",
40 41 
     "showdown": "^1.9.0",
41 42 
     "socket.io": "^4.3.2",
42 43 
     "sortablejs": "^1.7.0",

+ 25 - 0
iris-web/ui/src/css/kpi_dashboard.css
Näytä tiedosto 

@@ -0,0 +1,25 @@
1 
+/* KPI Alert Dashboard — styles */
2 
+
3 
+/* KPI bar — 4 segments */
4 
+.kpi-bar-wrap  { display:flex; flex-direction:column; gap:3px; min-width:120px; }
5 
+.kpi-segs      { display:flex; gap:4px; }
6 
+.kpi-seg       { width:26px; height:10px; border-radius:3px; }
7 
+
8 
+/* Scaled fill bar (width = kpi_pct%) */
9 
+.kpi-track     { width:100px; height:6px; background:#e5e7eb; border-radius:3px; overflow:hidden; }
10 
+.kpi-fill      { height:6px; border-radius:3px; transition:width 0.4s ease; }
11 
+.kpi-pct-label { font-size:10px; color:#6b7280; }
12 
+
13 
+/* Severity badges */
14 
+.badge-high    { background:#fed7aa; color:#c2410c; font-size:10px; padding:1px 6px; border-radius:999px; display:inline-block; }
15 
+.badge-medium  { background:#fef9c3; color:#854d0e; font-size:10px; padding:1px 6px; border-radius:999px; display:inline-block; }
16 
+.badge-low     { background:#d1fae5; color:#065f46; font-size:10px; padding:1px 6px; border-radius:999px; display:inline-block; }
17 
+
18 
+/* Status dot */
19 
+.status-dot    { width:10px; height:10px; border-radius:50%; display:inline-block; }
20 
+.dot-open      { background:#ef4444; }
21 
+.dot-closed    { background:#22c55e; }
22 
+
23 
+/* Sortable column headers */
24 
+.sortable      { cursor:pointer; user-select:none; }
25 
+.sortable:hover { background:#f1f5f9; }

+ 37 - 5
iris-web/ui/src/pages/alerts.js
Näytä tiedosto 

@@ -1,6 +1,32 @@
1 1 
 let sortOrder ;
2 2 
 let editor = null;
3 3
4 
+// ---------------------------------------------------------------------------
5 
+// KPI — fetch from soc-integrator, injected into alert objects before render
6 
+// ---------------------------------------------------------------------------
7 
+async function _fetchAlertKpi(alertId) {
8 
+  try {
9 
+    const res = await fetch(`/kpi-dashboard/api/alerts/${alertId}`);
10 
+    if (!res.ok) return null;
11 
+    const json = await res.json();
12 
+    return json.data?.alert?.kpi ?? null;
13 
+  } catch { return null; }
14 
+}
15 
+
16 
+function _renderAlertKpiBar(alert) {
17 
+  const kpi = alert.kpi;
18 
+  if (!kpi) return '';
19 
+  const segs = kpi.segments.map(s =>
20 
+    `<div style="width:20px;height:8px;border-radius:3px;background:${s.active ? s.color : '#e5e7eb'}" title="${s.label}"></div>`
21 
+  ).join('');
22 
+  return `
23 
+    <span title="KPI: ${kpi.status} — ${kpi.elapsed_pct}% elapsed" class="ml-3 d-inline-flex align-items-center" style="gap:4px">
24 
+      <b><i class="fa-solid fa-gauge-high"></i></b>
25 
+      <span style="display:flex;gap:3px">${segs}</span>
26 
+      <small class="text-muted ml-1">${kpi.status}</small>
27 
+    </span>`;
28 
+}
29 
+
4 30 
 function objectToQueryString(obj) {
5 31 
   return Object.keys(obj)
6 32 
     .filter(key => obj[key] !== undefined && obj[key] !== null && obj[key] !== '')
 
@@ -1239,6 +1265,7 @@ function renderAlert(alert, expanded=false, modulesOptionsAlertReq,
1239 1265 
                 <small class="text-muted ml-1">${formatTime(alert.alert_source_event_time)}</small></span>
1240 1266 
                 <span title="Alert severity"><b class="ml-3"><i class="fa-solid fa-bolt"></i></b>
1241 1267 
                   <small class="text-muted ml-1" id="alertSeverity-${alert.alert_id}" data-severity-id="${alert.severity.severity_id}">${alert.severity.severity_name}</small></span>
1268 
+                ${_renderAlertKpiBar(alert)}
1242 1269 
                 <span title="Alert source"><b class="ml-3"><i class="fa-solid fa-cloud-arrow-down"></i></b>
1243 1270 
                   <small class="text-muted ml-1">${filterXSS(alert.alert_source) || 'Unspecified'}</small></span>
1244 1271 
                 <span title="Alert client"><b class="ml-3"><i class="fa-regular fa-circle-user"></i></b>
 
@@ -1300,6 +1327,7 @@ async function showAlertHistory(alertId) {
1300 1327 
 }
1301 1328
1302 1329 
 async function refreshAlert(alertId, alertData, expanded=false) {
1330 
+    const kpiFetch = _fetchAlertKpi(alertId);
1303 1331 
     if (alertData === undefined) {
1304 1332 
         const alertDataReq = await fetchAlert(alertId);
1305 1333 
         if (api_request_failed(alertDataReq)) {
 
@@ -1307,6 +1335,8 @@ async function refreshAlert(alertId, alertData, expanded=false) {
1307 1335 
         }
1308 1336 
         alertData = alertDataReq.data;
1309 1337 
     }
1338 
+    const kpi = await kpiFetch;
1339 
+    if (kpi) alertData.kpi = kpi;
1310 1340
1311 1341 
       if (modulesOptionsAlertReq === null) {
1312 1342 
     modulesOptionsAlertReq = await fetchModulesOptionsAlert();
 
@@ -1359,12 +1389,14 @@ async function updateAlerts(page, per_page, filters = {}, paging=false){
1359 1389
1360 1390 
   const filterString = objectToQueryString(filters);
1361 1391 
   const data = await fetchAlerts(page, per_page, filterString, sortOrder).catch((error) => {
1362 
-        notify_error('Failed to fetch alerts');
1363 
-        alertsContainer.html('<h4 class="ml-auto mr-auto">Oops error loading the alerts - Check logs</h4>');
1364 
-        console.error(error);
1365 
-    });
1392 
+      notify_error('Failed to fetch alerts');
1393 
+      alertsContainer.html('<h4 class="ml-auto mr-auto">Oops error loading the alerts - Check logs</h4>');
1394 
+      console.error(error);
1395 
+  });
1396 
+  if (!data) return;
1366 1397
1367 
-  const alerts = data.data;
1398 
+  const kpiResults = await Promise.all(data.data.map(a => _fetchAlertKpi(a.alert_id)));
1399 
+  const alerts = data.data.map((a, i) => ({ ...a, kpi: kpiResults[i] ?? null }));
1368 1400
1369 1401 
   if (modulesOptionsAlertReq === null) {
1370 1402 
     modulesOptionsAlertReq = await fetchModulesOptionsAlert();

+ 314 - 0
iris-web/ui/src/pages/kpi_dashboard.js
Näytä tiedosto 

@@ -0,0 +1,314 @@
1 
+// KPI Alert Dashboard — vanilla JS, compiled by Vite into /static/assets/js/iris/kpi_dashboard.js
2 
+import '../css/kpi_dashboard.css';
3 
+
4 
+const API_BASE = '/kpi-dashboard/api';
5 
+
6 
+const state = {
7 
+  page: 1,
8 
+  perPage: 20,
9 
+  sortBy: 'alert_id',
10 
+  sortDir: 'desc',
11 
+  filterTitle: '',
12 
+  filterOwner: '',
13 
+  total: 0,
14 
+  selected: new Set(),
15 
+};
16 
+
17 
+// Debounce helper for filter inputs
18 
+let _debounceTimer = null;
19 
+function debouncedLoad() {
20 
+  clearTimeout(_debounceTimer);
21 
+  _debounceTimer = setTimeout(() => {
22 
+    state.page = 1;
23 
+    loadAlerts();
24 
+  }, 350);
25 
+}
26 
+
27 
+async function loadAlerts() {
28 
+  state.filterTitle = document.getElementById('filter-title').value;
29 
+  state.filterOwner = document.getElementById('filter-owner').value;
30 
+
31 
+  const params = new URLSearchParams({
32 
+    page: state.page,
33 
+    per_page: state.perPage,
34 
+    sort_by: state.sortBy,
35 
+    sort_dir: state.sortDir,
36 
+  });
37 
+  if (state.filterTitle) params.set('filter_title', state.filterTitle);
38 
+  if (state.filterOwner) params.set('filter_owner', state.filterOwner);
39 
+
40 
+  const body = document.getElementById('alerts-body');
41 
+  body.innerHTML = '<tr><td colspan="12" class="text-center text-muted py-4">Loading...</td></tr>';
42 
+
43 
+  try {
44 
+    const res = await fetch(`${API_BASE}/alerts?${params}`);
45 
+    if (!res.ok) throw new Error(`HTTP ${res.status}`);
46 
+    const json = await res.json();
47 
+    const alertsData = json.data?.alerts ?? {};
48 
+    const alerts = alertsData.data ?? [];
49 
+    state.total = alertsData.total ?? alerts.length;
50 
+    renderTable(alerts);
51 
+    updatePageInfo();
52 
+    updateSelectionLabel();
53 
+  } catch (err) {
54 
+    body.innerHTML = `<tr><td colspan="12" class="text-center text-danger py-4">Error: ${err.message}</td></tr>`;
55 
+  }
56 
+}
57 
+
58 
+function renderKpiBar(kpi) {
59 
+  if (!kpi) return '<span class="text-muted">—</span>';
60 
+  const containerW = 100;
61 
+  const fillW = Math.round((kpi.elapsed_pct / 100) * containerW);
62 
+  const fillColor = kpi.resolved ? '#6b7280'
63 
+    : kpi.elapsed_pct >= 75 ? '#ef4444'
64 
+    : kpi.elapsed_pct >= 50 ? '#f97316'
65 
+    : kpi.elapsed_pct >= 25 ? '#eab308'
66 
+    : '#22c55e';
67 
+
68 
+  const segs = (kpi.segments || []).map(s =>
69 
+    `<div class="kpi-seg" style="background:${s.active ? s.color : '#e5e7eb'}" title="${s.label}: ${s.active ? 'active' : 'inactive'}"></div>`
70 
+  ).join('');
71 
+
72 
+  return `
73 
+    <div class="kpi-bar-wrap" title="${kpi.status} — ${kpi.elapsed_pct}% elapsed">
74 
+      <div class="kpi-segs">${segs}</div>
75 
+      <div class="kpi-track">
76 
+        <div class="kpi-fill" style="width:${fillW}px;background:${fillColor}"></div>
77 
+      </div>
78 
+      <span class="kpi-pct-label">${kpi.status}</span>
79 
+    </div>`;
80 
+}
81 
+
82 
+function severityBadge(severity) {
83 
+  if (!severity) return '';
84 
+  const name = (severity.severity_name || '').toLowerCase();
85 
+  const cls = name === 'high' ? 'badge-high' : name === 'medium' ? 'badge-medium' : 'badge-low';
86 
+  return `<span class="${cls}">${severity.severity_name || ''}</span>`;
87 
+}
88 
+
89 
+function statusDot(status) {
90 
+  if (!status) return '';
91 
+  const name = (status.status_name || '').toLowerCase();
92 
+  const cls = name === 'closed' ? 'dot-closed' : 'dot-open';
93 
+  return `<span class="status-dot ${cls}" title="${status.status_name || ''}"></span>`;
94 
+}
95 
+
96 
+function fmtDate(str) {
97 
+  if (!str) return '—';
98 
+  try {
99 
+    return new Date(str).toLocaleString();
100 
+  } catch {
101 
+    return str;
102 
+  }
103 
+}
104 
+
105 
+function renderTable(alerts) {
106 
+  const body = document.getElementById('alerts-body');
107 
+  if (!alerts.length) {
108 
+    body.innerHTML = '<tr><td colspan="12" class="text-center text-muted py-4">No alerts found.</td></tr>';
109 
+    return;
110 
+  }
111 
+
112 
+  body.innerHTML = alerts.map(alert => {
113 
+    const id = alert.alert_id ?? '';
114 
+    const checked = state.selected.has(id) ? 'checked' : '';
115 
+    const owner = (alert.owner || {}).user_name || '—';
116 
+    const classification = (alert.classification || {}).name || '—';
117 
+    const closedAt = alert.alert_close_timestamp ? fmtDate(alert.alert_close_timestamp) : '—';
118 
+    return `
119 
+      <tr class="alert-row" style="cursor:pointer" onclick="openAlertDetail(${id}, event)">
120 
+        <td><input type="checkbox" class="row-chk" data-id="${id}" ${checked} onchange="toggleRow(this)"></td>
121 
+        <td>${statusDot(alert.status)}</td>
122 
+        <td>${owner}</td>
123 
+        <td>${id}</td>
124 
+        <td>${alert.alert_title || '—'}</td>
125 
+        <td>${classification}</td>
126 
+        <td>${severityBadge(alert.severity)}</td>
127 
+        <td>${fmtDate(alert.alert_creation_time)}</td>
128 
+        <td>${renderKpiBar(alert.kpi)}</td>
129 
+        <td>${fmtDate(alert.alert_source_event_time)}</td>
130 
+        <td>${closedAt}</td>
131 
+        <td>—</td>
132 
+      </tr>`;
133 
+  }).join('');
134 
+}
135 
+
136 
+function toggleAll(chk) {
137 
+  document.querySelectorAll('.row-chk').forEach(el => {
138 
+    el.checked = chk.checked;
139 
+    const id = Number(el.dataset.id);
140 
+    if (chk.checked) state.selected.add(id);
141 
+    else state.selected.delete(id);
142 
+  });
143 
+  updateSelectionLabel();
144 
+}
145 
+
146 
+function toggleRow(el) {
147 
+  const id = Number(el.dataset.id);
148 
+  if (el.checked) state.selected.add(id);
149 
+  else state.selected.delete(id);
150 
+  updateSelectionLabel();
151 
+}
152 
+
153 
+function updateSelectionLabel() {
154 
+  // selection label removed from UI
155 
+}
156 
+
157 
+function updatePageInfo() {
158 
+  const el = document.getElementById('page-info');
159 
+  if (el) {
160 
+    const totalPages = Math.max(1, Math.ceil(state.total / state.perPage));
161 
+    el.textContent = `Page ${state.page} of ${totalPages} (${state.total} total)`;
162 
+  }
163 
+}
164 
+
165 
+function prevPage() {
166 
+  if (state.page > 1) {
167 
+    state.page--;
168 
+    refreshActive();
169 
+  }
170 
+}
171 
+
172 
+function nextPage() {
173 
+  const totalPages = Math.ceil(state.total / state.perPage);
174 
+  if (state.page < totalPages) {
175 
+    state.page++;
176 
+    refreshActive();
177 
+  }
178 
+}
179 
+
180 
+function sortBy(col) {
181 
+  if (state.sortBy === col) {
182 
+    state.sortDir = state.sortDir === 'asc' ? 'desc' : 'asc';
183 
+  } else {
184 
+    state.sortBy = col;
185 
+    state.sortDir = 'desc';
186 
+  }
187 
+  state.page = 1;
188 
+  loadAlerts();
189 
+}
190 
+
191 
+async function assignSelected() {
192 
+  if (!state.selected.size) {
193 
+    alert('No alerts selected.');
194 
+    return;
195 
+  }
196 
+  const ownerIdStr = prompt('Enter owner user ID to assign:');
197 
+  if (!ownerIdStr) return;
198 
+  const ownerId = parseInt(ownerIdStr, 10);
199 
+  if (isNaN(ownerId)) {
200 
+    alert('Invalid owner ID.');
201 
+    return;
202 
+  }
203 
+  const ids = Array.from(state.selected);
204 
+  try {
205 
+    await Promise.all(ids.map(id =>
206 
+      fetch(`${API_BASE}/alerts/${id}/assign`, {
207 
+        method: 'POST',
208 
+        headers: { 'Content-Type': 'application/json' },
209 
+        body: JSON.stringify({ owner_id: ownerId }),
210 
+      })
211 
+    ));
212 
+    state.selected.clear();
213 
+    loadAlerts();
214 
+  } catch (err) {
215 
+    alert(`Assignment failed: ${err.message}`);
216 
+  }
217 
+}
218 
+
219 
+function exportCsv() {
220 
+  const params = new URLSearchParams({
221 
+    sort_by: state.sortBy,
222 
+    sort_dir: state.sortDir,
223 
+  });
224 
+  if (state.filterTitle) params.set('filter_title', state.filterTitle);
225 
+  if (state.filterOwner) params.set('filter_owner', state.filterOwner);
226 
+  window.location.href = `${API_BASE}/alerts/export-csv?${params}`;
227 
+}
228 
+
229 
+let activeTab = 'alerts';
230 
+
231 
+function switchTab(tab) {
232 
+  activeTab = tab;
233 
+  document.getElementById('tab-alerts').classList.toggle('active', tab === 'alerts');
234 
+  document.getElementById('tab-cases').classList.toggle('active', tab === 'cases');
235 
+  state.page = 1;
236 
+  activeTab === 'alerts' ? loadAlerts() : loadCases();
237 
+}
238 
+
239 
+async function loadCases() {
240 
+  const params = new URLSearchParams({
241 
+    page: state.page,
242 
+    per_page: state.perPage,
243 
+    sort_by: state.sortBy,
244 
+    sort_dir: state.sortDir,
245 
+  });
246 
+  const body = document.getElementById('alerts-body');
247 
+  body.innerHTML = '<tr><td colspan="12" class="text-center text-muted py-4">Loading...</td></tr>';
248 
+  try {
249 
+    const res = await fetch(`${API_BASE}/cases?${params}`);
250 
+    if (!res.ok) throw new Error(`HTTP ${res.status}`);
251 
+    const json = await res.json();
252 
+    const casesData = json.data?.cases ?? {};
253 
+    const cases = casesData.data ?? [];
254 
+    state.total = casesData.total ?? cases.length;
255 
+    renderCasesTable(cases);
256 
+    updatePageInfo();
257 
+  } catch (err) {
258 
+    body.innerHTML = `<tr><td colspan="12" class="text-center text-danger py-4">Error: ${err.message}</td></tr>`;
259 
+  }
260 
+}
261 
+
262 
+function renderCasesTable(cases) {
263 
+  const body = document.getElementById('alerts-body');
264 
+  if (!cases.length) {
265 
+    body.innerHTML = '<tr><td colspan="12" class="text-center text-muted py-4">No cases found.</td></tr>';
266 
+    return;
267 
+  }
268 
+  body.innerHTML = cases.map(c => {
269 
+    const owner = (c.owner || {}).user_name || '—';
270 
+    const stateName = (c.state || {}).state_name || '—';
271 
+    const closed = c.close_date ? fmtDate(c.close_date) : '—';
272 
+    return `<tr>
273 
+      <td></td>
274 
+      <td>${statusDot({status_name: stateName})}</td>
275 
+      <td>${owner}</td>
276 
+      <td>${c.case_id ?? ''}</td>
277 
+      <td>${c.case_name || '—'}</td>
278 
+      <td>${c.case_soc_id || '—'}</td>
279 
+      <td>—</td>
280 
+      <td>${fmtDate(c.open_date)}</td>
281 
+      <td>${renderKpiBar(c.kpi)}</td>
282 
+      <td>—</td>
283 
+      <td>${closed}</td>
284 
+      <td>—</td>
285 
+    </tr>`;
286 
+  }).join('');
287 
+}
288 
+
289 
+function openAlertDetail(alertId, event) {
290 
+  // Don't navigate when clicking the checkbox
291 
+  if (event && event.target.type === 'checkbox') return;
292 
+  window.location.href = `/alerts?alert_ids=${alertId}&cid=1`;
293 
+}
294 
+
295 
+function refreshActive() {
296 
+  activeTab === 'alerts' ? loadAlerts() : loadCases();
297 
+}
298 
+
299 
+// Auto-load on page ready
300 
+document.addEventListener('DOMContentLoaded', loadAlerts);
301 
+setInterval(refreshActive, 60_000);
302 
+
303 
+// Expose for inline onclick handlers
304 
+window.debouncedLoad = debouncedLoad;
305 
+window.loadAlerts = loadAlerts;
306 
+window.toggleAll = toggleAll;
307 
+window.toggleRow = toggleRow;
308 
+window.assignSelected = assignSelected;
309 
+window.exportCsv = exportCsv;
310 
+window.prevPage = prevPage;
311 
+window.nextPage = nextPage;
312 
+window.sortBy = sortBy;
313 
+window.switchTab = switchTab;
314 
+window.openAlertDetail = openAlertDetail;

+ 46 - 2
iris-web/ui/src/pages/manage.cases.js
Näytä tiedosto 

@@ -26,7 +26,31 @@ $('#classification_id').prepend(new Option('', ''));
26 26
27 27
28 28 
  /*************************
29 
- *  Case list section
29 
+ *  KPI helpers
30 
+ *************************/
31 
+async function _fetchCaseKpi(caseId) {
32 
+  try {
33 
+    const res = await fetch(`/kpi-dashboard/api/cases/${caseId}`);
34 
+    if (!res.ok) return null;
35 
+    const json = await res.json();
36 
+    return json.data?.case?.kpi ?? null;
37 
+  } catch { return null; }
38 
+}
39 
+
40 
+function _renderCaseKpiBar(kpi) {
41 
+  if (!kpi) return '<span class="text-muted">—</span>';
42 
+  const segs = (kpi.segments || []).map(s =>
43 
+    `<div style="width:18px;height:8px;border-radius:3px;background:${s.active ? s.color : '#e5e7eb'}" title="${s.label}"></div>`
44 
+  ).join('');
45 
+  return `<span title="KPI: ${kpi.status} — ${kpi.elapsed_pct}% elapsed" style="display:inline-flex;align-items:center;gap:4px">
46 
+    <b><i class="fa-solid fa-gauge-high"></i></b>
47 
+    <span style="display:flex;gap:3px">${segs}</span>
48 
+    <small class="text-muted">${kpi.status}</small>
49 
+  </span>`;
50 
+}
51 
+
52 
+ /*************************
53 
+ *  Case list section
30 54 
  *************************/
31 55 
 /* case table creation */
32 56 
 $.each($.find("table"), function(index, element){
 
@@ -112,6 +136,17 @@ $('#cases_table').dataTable({
112 136 
             if (type === 'display') { data = sanitizeHTML(data);}
113 137 
             return data;
114 138 
           }
139 
+        },
140 
+        {
141 
+            "data": "case_id",
142 
+            "orderable": false,
143 
+            "searchable": false,
144 
+            "render": function (data, type, row) {
145 
+                if (type === 'display') {
146 
+                    return `<span id="case-kpi-${data}"><small class="text-muted">…</small></span>`;
147 
+                }
148 
+                return data;
149 
+            }
115 150 
         }
116 151 
     ],
117 152 
     dom: '<"container-fluid"<"row"<"col"l><"col"f>>>rt<"container-fluid"<"row"<"col"i><"col"p>>>',
 
@@ -133,7 +168,16 @@ $('#cases_table').dataTable({
133 168 
     },
134 169 
     initComplete: function () {
135 170 
             tableFiltering(this.api(), 'cases_table');
136 
-        }
171 
+        },
172 
+    drawCallback: function () {
173 
+        const api = this.api();
174 
+        api.rows({ page: 'current' }).data().each(function (row) {
175 
+            const caseId = row.case_id;
176 
+            _fetchCaseKpi(caseId).then(kpi => {
177 
+                $(`#case-kpi-${caseId}`).html(_renderCaseKpiBar(kpi));
178 
+            });
179 
+        });
180 
+    }
137 181 
     }
138 182 
 );
139 183

+ 1 - 1
run-combined-stack.sh
Näytä tiedosto 

@@ -101,7 +101,7 @@ run_iris() {
101 101 
   docker compose \
102 102 
     --project-name iris-web \
103 103 
     --project-directory "${ROOT_DIR}/iris-web" \
104 
-    -f "${ROOT_DIR}/iris-web/docker-compose.yml" \
104 
+    -f "${ROOT_DIR}/iris-web/docker-compose.dev.yml" \
105 105 
     -f "${ROOT_DIR}/compose-overrides/iris.shared-network.yml" \
106 106 
     "${COMMAND}" ${ARGS[@]+"${ARGS[@]}"}
107 107 
 }

+ 358 - 0
scripts/seed-kpi-test-data.py
Näytä tiedosto 

@@ -0,0 +1,358 @@
1 
+#!/usr/bin/env python3
2 
+"""
3 
+seed-kpi-test-data.py — Create test IRIS alerts and cases for KPI dashboard UI testing.
4 
+
5 
+Creates a spread of records covering every KPI state:
6 
+  On Track | Watch | Warning | Urgent | Critical | Breached | Resolved
7 
+
8 
+Usage:
9 
+  python3 scripts/seed-kpi-test-data.py [--alerts-only] [--cases-only] [--dry-run]
10 
+
11 
+Env vars (override defaults):
12 
+  IRIS_BASE_URL   default: https://localhost:8443
13 
+  IRIS_API_KEY    required
14 
+"""
15 
+import argparse
16 
+import json
17 
+import os
18 
+import ssl
19 
+import sys
20 
+import urllib.request
21 
+from datetime import datetime, timedelta, timezone
22 
+from pathlib import Path
23 
+
24 
+# ---------------------------------------------------------------------------
25 
+# Config
26 
+# ---------------------------------------------------------------------------
27 
+
28 
+def _read_env_file(path: str, key: str) -> str:
29 
+    p = Path(path)
30 
+    if not p.exists():
31 
+        return ""
32 
+    for line in p.read_text().splitlines():
33 
+        if line.startswith(f"{key}="):
34 
+            return line[len(key) + 1:].strip()
35 
+    return ""
36 
+
37 
+BASE_DIR = Path(__file__).parent.parent
38 
+ENV_FILE = BASE_DIR / "soc-integrator" / ".env"
39 
+
40 
+IRIS_BASE_URL = (
41 
+    os.environ.get("IRIS_BASE_URL")
42 
+    or _read_env_file(str(ENV_FILE), "IRIS_BASE_URL")
43 
+    or "https://localhost:8443"
44 
+).rstrip("/").replace("iriswebapp_nginx", "localhost")
45 
+
46 
+IRIS_API_KEY = (
47 
+    os.environ.get("IRIS_API_KEY")
48 
+    or _read_env_file(str(ENV_FILE), "IRIS_API_KEY")
49 
+    or ""
50 
+)
51 
+
52 
+if not IRIS_API_KEY:
53 
+    sys.exit("error: IRIS_API_KEY not set. Export it or add it to soc-integrator/.env")
54 
+
55 
+# ---------------------------------------------------------------------------
56 
+# HTTP helpers (no extra deps)
57 
+# ---------------------------------------------------------------------------
58 
+
59 
+_ssl_ctx = ssl.create_default_context()
60 
+_ssl_ctx.check_hostname = False
61 
+_ssl_ctx.verify_mode = ssl.CERT_NONE
62 
+
63 
+
64 
+def _req(method: str, path: str, body: dict | None = None) -> dict:
65 
+    url = f"{IRIS_BASE_URL}{path}"
66 
+    data = json.dumps(body).encode() if body else None
67 
+    headers = {
68 
+        "Authorization": f"Bearer {IRIS_API_KEY}",
69 
+        "Content-Type": "application/json",
70 
+    }
71 
+    req = urllib.request.Request(url, data=data, headers=headers, method=method)
72 
+    with urllib.request.urlopen(req, context=_ssl_ctx, timeout=15) as r:
73 
+        return json.loads(r.read())
74 
+
75 
+
76 
+def get(path: str) -> dict:
77 
+    return _req("GET", path)
78 
+
79 
+
80 
+def post(path: str, body: dict) -> dict:
81 
+    return _req("POST", path, body)
82 
+
83 
+
84 
+def put(path: str, body: dict) -> dict:
85 
+    return _req("PUT", path, body)
86 
+
87 
+
88 
+# ---------------------------------------------------------------------------
89 
+# Lookup tables
90 
+# ---------------------------------------------------------------------------
91 
+
92 
+def _get_severity_ids() -> dict[str, int]:
93 
+    """Return name→id map for alert severities."""
94 
+    data = get("/manage/severities/list")
95 
+    items = (data.get("data") or [])
96 
+    return {s["severity_name"].lower(): s["severity_id"] for s in items if "severity_name" in s}
97 
+
98 
+
99 
+def _get_alert_status_ids() -> dict[str, int]:
100 
+    data = get("/manage/alert-status/list")
101 
+    items = data.get("data") or []
102 
+    return {s["status_name"].lower(): s["status_id"] for s in items if "status_name" in s}
103 
+
104 
+
105 
+def _get_resolution_status_ids() -> dict[str, int]:
106 
+    try:
107 
+        data = get("/manage/alert-resolutions/list")
108 
+        items = data.get("data") or []
109 
+        return {s["resolution_status_name"].lower(): s["resolution_status_id"]
110 
+                for s in items if "resolution_status_name" in s}
111 
+    except Exception:
112 
+        return {}
113 
+
114 
+
115 
+def _get_customer_id() -> int:
116 
+    try:
117 
+        data = get("/api/v2/customers")
118 
+        items = (data.get("data") or {}).get("customers") or []
119 
+        if items:
120 
+            return items[0].get("customer_id", 1)
121 
+    except Exception:
122 
+        pass
123 
+    return 1
124 
+
125 
+
126 
+# ---------------------------------------------------------------------------
127 
+# Alert scenarios
128 
+# ---------------------------------------------------------------------------
129 
+
130 
+def _ts(offset_hours: float) -> str:
131 
+    """ISO timestamp offset_hours ago (UTC, naive — what IRIS expects)."""
132 
+    dt = datetime.now(timezone.utc) - timedelta(hours=offset_hours)
133 
+    return dt.strftime("%Y-%m-%dT%H:%M:%S")
134 
+
135 
+
136 
+def _date(offset_hours: float) -> str:
137 
+    """Date string (YYYY-MM-DD) offset_hours ago — for case close_date."""
138 
+    dt = datetime.now(timezone.utc) - timedelta(hours=offset_hours)
139 
+    return dt.strftime("%Y-%m-%d")
140 
+
141 
+
142 
+# Each tuple: (label, severity, created_hours_ago, resolved_hours_after_creation_or_None)
143 
+# SLA: High=4h  Medium=8h  Low=24h
144 
+ALERT_SCENARIOS = [
145 
+    # --- High severity (4h SLA) ---
146 
+    ("High / On Track (1h old)",       "High",   1.0,   None),   # 75% remaining
147 
+    ("High / Watch (2.5h old)",        "High",   2.5,   None),   # ~37% remaining → Watch
148 
+    ("High / Warning (3h old)",        "High",   3.0,   None),   # 25% remaining
149 
+    ("High / Breached (6h old)",       "High",   6.0,   None),   # 0%
150 
+    ("High / Resolved in SLA (2h)",    "High",   4.0,   2.0),    # resolved 2h after open → 50% KPI frozen
151 
+    ("High / Resolved breached (5h)",  "High",   7.0,   5.0),    # resolved after SLA breach → Resolved/0%
152 
+    # --- Medium severity (8h SLA) ---
153 
+    ("Medium / On Track (1h old)",     "Medium", 1.0,   None),
154 
+    ("Medium / Watch (3h old)",        "Medium", 3.0,   None),
155 
+    ("Medium / Warning (5h old)",      "Medium", 5.0,   None),
156 
+    ("Medium / Urgent (7h old)",       "Medium", 7.0,   None),
157 
+    ("Medium / Critical (7.8h old)",   "Medium", 7.8,   None),
158 
+    ("Medium / Breached (10h old)",    "Medium", 10.0,  None),
159 
+    ("Medium / Resolved in SLA (4h)",  "Medium", 9.0,   4.0),
160 
+    # --- Low severity (24h SLA) ---
161 
+    ("Low / On Track (2h old)",        "Low",    2.0,   None),
162 
+    ("Low / Warning (14h old)",        "Low",    14.0,  None),
163 
+    ("Low / Breached (30h old)",       "Low",    30.0,  None),
164 
+    ("Low / Resolved in SLA (12h)",    "Low",    25.0,  12.0),
165 
+]
166 
+
167 
+# Case scenarios: (label, tags, created_hours_ago, close_hours_after_creation_or_None)
168 
+CASE_SCENARIOS = [
169 
+    ("High / Open On Track",           "High,wazuh",         1.0,   None),
170 
+    ("High / Open Watch",              "High,brute-force",   2.5,   None),
171 
+    ("High / Breached",                "High,lateral-movement", 6.0, None),
172 
+    ("High / Resolved in SLA",         "High,exfiltration",  5.0,   2.0),
173 
+    ("Medium / Open Watch",            "Medium,wazuh",       3.0,   None),
174 
+    ("Medium / Open Urgent",           "Medium,phishing",    7.0,   None),
175 
+    ("Medium / Breached",              "Medium,ransomware",  12.0,  None),
176 
+    ("Medium / Resolved",              "Medium,malware",     10.0,  5.0),
177 
+    ("Low / On Track",                 "Low,wazuh",          2.0,   None),
178 
+    ("Low / Warning",                  "Low,recon",          14.0,  None),
179 
+    ("Low / Resolved in SLA",          "Low,policy",         26.0,  10.0),
180 
+]
181 
+
182 
+
183 
+# ---------------------------------------------------------------------------
184 
+# Create alerts
185 
+# ---------------------------------------------------------------------------
186 
+
187 
+def create_alerts(sev_ids: dict, status_ids: dict, res_ids: dict, customer_id: int, dry_run: bool):
188 
+    new_id = status_ids.get("new") or 2
189 
+    closed_id = status_ids.get("closed") or 6
190 
+    # Pick any "true positive" resolution, falling back to first available
191 
+    res_tp_id = (
192 
+        res_ids.get("true positive with impact")
193 
+        or res_ids.get("true positive without impact")
194 
+        or (list(res_ids.values())[0] if res_ids else 2)
195 
+    )
196 
+
197 
+    print(f"\n=== Creating {len(ALERT_SCENARIOS)} alerts ===")
198 
+    for label, sev_name, created_h, resolved_h in ALERT_SCENARIOS:
199 
+        sev_id = sev_ids.get(sev_name.lower()) or sev_ids.get("medium") or 3
200 
+        created_ts = _ts(created_h)
201 
+
202 
+        payload: dict = {
203 
+            "alert_title": f"[KPI Test] {label}",
204 
+            "alert_description": f"Seed data: {label}. Created {created_h}h ago.",
205 
+            "alert_severity_id": sev_id,
206 
+            "alert_status_id": new_id,
207 
+            "alert_customer_id": customer_id,
208 
+            "alert_source": "kpi-seed",
209 
+            "alert_source_ref": "seed-kpi-test-data",
210 
+            "alert_source_event_time": created_ts,
211 
+            "alert_creation_time": created_ts,
212 
+        }
213 
+
214 
+        if resolved_h is not None:
215 
+            payload["alert_status_id"] = closed_id
216 
+            if res_tp_id:
217 
+                payload["alert_resolution_status_id"] = res_tp_id
218 
+
219 
+        if dry_run:
220 
+            print(f"  DRY-RUN  {label}")
221 
+            continue
222 
+
223 
+        try:
224 
+            resp = post("/alerts/add", payload)
225 
+            alert_data = resp.get("data") or {}
226 
+            aid = alert_data.get("alert_id", "?")
227 
+            print(f"  created  alert_id={aid}  {label}")
228 
+        except Exception as exc:
229 
+            print(f"  FAILED   {label}: {exc}")
230 
+
231 
+
232 
+# ---------------------------------------------------------------------------
233 
+# Create cases
234 
+# ---------------------------------------------------------------------------
235 
+
236 
+def create_cases(customer_id: int, dry_run: bool):
237 
+    print(f"\n=== Creating {len(CASE_SCENARIOS)} cases ===")
238 
+    for label, tags, created_h, close_h in CASE_SCENARIOS:
239 
+        open_date = _ts(created_h)
240 
+        # close_date: a date-only string (IRIS v2 close_date is a date, not datetime)
241 
+        close_date = _date(created_h - close_h) if close_h is not None else None
242 
+
243 
+        payload: dict = {
244 
+            "case_name": f"[KPI Test] {label}",
245 
+            "case_description": f"Seed data: {label}. Opened {created_h}h ago.",
246 
+            "case_customer": customer_id,
247 
+            "case_tags": tags,
248 
+            "case_soc_id": "seed-kpi",
249 
+        }
250 
+
251 
+        if dry_run:
252 
+            print(f"  DRY-RUN  {label}")
253 
+            continue
254 
+
255 
+        try:
256 
+            resp = post("/api/v2/cases", payload)
257 
+            # v2 create returns the case object directly (no data wrapper)
258 
+            cid = resp.get("case_id") or (resp.get("data") or {}).get("case_id", "?")
259 
+            print(f"  created  case_id={cid}  {label}")
260 
+
261 
+            # Close the case if needed — IRIS v2: PUT /api/v2/cases/{id} with close_date
262 
+            if close_date and cid and cid != "?":
263 
+                try:
264 
+                    put(f"/api/v2/cases/{cid}", {"close_date": close_date})
265 
+                    print(f"           └─ closed at {close_date}")
266 
+                except Exception as exc:
267 
+                    print(f"           └─ close failed: {exc}")
268 
+        except Exception as exc:
269 
+            print(f"  FAILED   {label}: {exc}")
270 
+
271 
+
272 
+# ---------------------------------------------------------------------------
273 
+# Main
274 
+# ---------------------------------------------------------------------------
275 
+
276 
+def _backdate_alerts_via_db(scenarios: list, dry_run: bool):
277 
+    """Update alert_creation_time and modification_history in Postgres via docker exec."""
278 
+    import subprocess
279 
+
280 
+    lines = []
281 
+    for label, sev, created_h, resolved_h in scenarios:
282 
+        title_sql = label.replace("'", "''")
283 
+        lines.append(
284 
+            f"UPDATE alerts SET alert_creation_time = NOW() - INTERVAL '{int(created_h * 60)} minutes' "
285 
+            f"WHERE alert_title = '[KPI Test] {title_sql}';"
286 
+        )
287 
+        if resolved_h is not None:
288 
+            elapsed_h = created_h - resolved_h          # hours from now to resolution
289 
+            lines.append(
290 
+                f"WITH ts AS (SELECT EXTRACT(EPOCH FROM NOW() - INTERVAL '{int(elapsed_h * 60)} minutes') AS t) "
291 
+                f"UPDATE alerts SET modification_history = jsonb_build_object((SELECT t::text FROM ts), "
292 
+                f"'{{\"user\":\"seed\",\"action\":\"Alert resolved\"}}') "
293 
+                f"WHERE alert_title = '[KPI Test] {title_sql}';"
294 
+            )
295 
+
296 
+    sql = "\n".join(lines)
297 
+    print("\n--- Backdating alert timestamps via docker exec ---")
298 
+    if dry_run:
299 
+        print("  DRY-RUN (SQL would be):")
300 
+        print(sql[:500] + "...")
301 
+        return
302 
+    result = subprocess.run(
303 
+        ["docker", "exec", "iriswebapp_db", "psql", "-U", "postgres", "-d", "iris_db", "-c", sql],
304 
+        capture_output=True, text=True,
305 
+    )
306 
+    if result.returncode != 0:
307 
+        print(f"  WARN: backdate failed: {result.stderr[:300]}")
308 
+    else:
309 
+        print("  done.")
310 
+
311 
+
312 
+def main():
313 
+    parser = argparse.ArgumentParser(description=__doc__, formatter_class=argparse.RawDescriptionHelpFormatter)
314 
+    parser.add_argument("--alerts-only", action="store_true")
315 
+    parser.add_argument("--cases-only", action="store_true")
316 
+    parser.add_argument("--backdate", action="store_true",
317 
+                        help="Update alert_creation_time in PostgreSQL via docker exec after creation")
318 
+    parser.add_argument("--dry-run", action="store_true", help="Print what would be created without calling IRIS")
319 
+    args = parser.parse_args()
320 
+
321 
+    print(f"IRIS: {IRIS_BASE_URL}")
322 
+
323 
+    if args.dry_run:
324 
+        print("DRY-RUN mode — no requests will be made\n")
325 
+        if not args.cases_only:
326 
+            create_alerts({}, {}, {}, 1, dry_run=True)
327 
+            if args.backdate:
328 
+                _backdate_alerts_via_db(ALERT_SCENARIOS, dry_run=True)
329 
+        if not args.alerts_only:
330 
+            create_cases(1, dry_run=True)
331 
+        return
332 
+
333 
+    print("Fetching IRIS lookup tables...")
334 
+    try:
335 
+        sev_ids = _get_severity_ids()
336 
+        status_ids = _get_alert_status_ids()
337 
+        res_ids = _get_resolution_status_ids()
338 
+        customer_id = _get_customer_id()
339 
+    except Exception as exc:
340 
+        sys.exit(f"error: could not reach IRIS at {IRIS_BASE_URL}: {exc}")
341 
+
342 
+    print(f"  severities:    {sev_ids}")
343 
+    print(f"  alert statuses:{status_ids}")
344 
+    print(f"  resolution:    {res_ids}")
345 
+    print(f"  customer_id:   {customer_id}")
346 
+
347 
+    if not args.cases_only:
348 
+        create_alerts(sev_ids, status_ids, res_ids, customer_id, dry_run=False)
349 
+        if args.backdate:
350 
+            _backdate_alerts_via_db(ALERT_SCENARIOS, dry_run=False)
351 
+    if not args.alerts_only:
352 
+        create_cases(customer_id, dry_run=False)
353 
+
354 
+    print("\ndone.")
355 
+
356 
+
357 
+if __name__ == "__main__":
358 
+    main()

+ 95 - 1
soc-integrator/app/adapters/iris.py
Näytä tiedosto 

@@ -67,8 +67,9 @@ class IrisAdapter:
67 67 
         headers = self._headers()
68 68 
         safe_limit = max(1, limit)
69 69 
         safe_offset = max(0, offset)
70 
+        page = (safe_offset // safe_limit) + 1
70 71 
         v2_url = f"{self.base_url}/api/v2/cases"
71 
-        params = {"limit": safe_limit, "offset": safe_offset}
72 
+        params = {"page": page, "per_page": safe_limit}
72 73 
         async with httpx.AsyncClient(verify=False, timeout=20.0) as client:
73 74 
             response = await client.get(v2_url, params=params, headers=headers)
74 75 
             active_url = v2_url
 
@@ -112,6 +113,9 @@ class IrisAdapter:
112 113 
                 return {"status_code": response.status_code}
113 114
114 115 
             result = response.json()
116 
+            # IRIS v2 response: { "total": int, "data": [...], "last_page": int, ... }
117 
+            if isinstance(result, dict) and isinstance(result.get("total"), int) and isinstance(result.get("data"), list):
118 
+                return result  # pass v2 response through directly
115 119 
             if isinstance(result, dict) and isinstance(result.get("data"), list):
116 120 
                 total = result.get("recordsTotal")
117 121 
                 if not isinstance(total, int):
 
@@ -125,3 +129,93 @@ class IrisAdapter:
125 129 
                     "raw": result,
126 130 
                 }
127 131 
             return result
132 
+
133 
+    async def create_alert(self, payload: dict[str, Any]) -> dict[str, Any]:
134 
+        headers = self._headers()
135 
+        url = f"{self.base_url}/alerts/add"
136 
+        async with httpx.AsyncClient(verify=False, timeout=20.0) as client:
137 
+            response = await client.post(url, json=payload, headers=headers)
138 
+            try:
139 
+                response.raise_for_status()
140 
+            except httpx.HTTPStatusError as exc:
141 
+                detail = response.text.strip()
142 
+                raise RuntimeError(
143 
+                    f"IRIS returned {response.status_code} for {url}. Response: {detail}"
144 
+                ) from exc
145 
+            return response.json() if response.content else {"status_code": response.status_code}
146 
+
147 
+    async def get_case(self, case_id: int) -> dict[str, Any]:
148 
+        headers = self._headers()
149 
+        url = f"{self.base_url}/api/v2/cases/{case_id}"
150 
+        async with httpx.AsyncClient(verify=False, timeout=20.0) as client:
151 
+            response = await client.get(url, headers=headers)
152 
+            try:
153 
+                response.raise_for_status()
154 
+            except httpx.HTTPStatusError as exc:
155 
+                detail = response.text.strip()
156 
+                raise RuntimeError(
157 
+                    f"IRIS returned {response.status_code} for {url}. Response: {detail}"
158 
+                ) from exc
159 
+            return response.json() if response.content else {}
160 
+
161 
+    async def get_alert(self, alert_id: int) -> dict[str, Any]:
162 
+        headers = self._headers()
163 
+        url = f"{self.base_url}/alerts/{alert_id}"
164 
+        async with httpx.AsyncClient(verify=False, timeout=20.0) as client:
165 
+            response = await client.get(url, headers=headers)
166 
+            try:
167 
+                response.raise_for_status()
168 
+            except httpx.HTTPStatusError as exc:
169 
+                detail = response.text.strip()
170 
+                raise RuntimeError(
171 
+                    f"IRIS returned {response.status_code} for {url}. Response: {detail}"
172 
+                ) from exc
173 
+            result = response.json() if response.content else {}
174 
+            # Legacy endpoint returns {"status": "success", "data": {...}}
175 
+            return result.get("data", result)
176 
+
177 
+    async def list_alerts(
178 
+        self,
179 
+        page: int = 1,
180 
+        per_page: int = 50,
181 
+        sort_by: str = "alert_id",
182 
+        sort_dir: str = "desc",
183 
+        filter_title: str | None = None,
184 
+        filter_owner_id: int | None = None,
185 
+    ) -> dict[str, Any]:
186 
+        headers = self._headers()
187 
+        url = f"{self.base_url}/api/v2/alerts"
188 
+        params: dict[str, Any] = {
189 
+            "page": max(1, page),
190 
+            "per_page": max(1, per_page),
191 
+            "sort": f"{sort_by}:{sort_dir}",
192 
+        }
193 
+        if filter_title:
194 
+            params["alert_title"] = filter_title
195 
+        if filter_owner_id:
196 
+            params["alert_owner_id"] = filter_owner_id
197 
+        async with httpx.AsyncClient(verify=False, timeout=30.0) as client:
198 
+            response = await client.get(url, params=params, headers=headers)
199 
+            try:
200 
+                response.raise_for_status()
201 
+            except httpx.HTTPStatusError as exc:
202 
+                detail = response.text.strip()
203 
+                raise RuntimeError(
204 
+                    f"IRIS returned {response.status_code} for {url}. Response: {detail}"
205 
+                ) from exc
206 
+            return response.json() if response.content else {"status_code": response.status_code}
207 
+
208 
+    async def assign_alert(self, alert_id: int, owner_id: int) -> dict[str, Any]:
209 
+        headers = self._headers()
210 
+        url = f"{self.base_url}/api/v2/alerts/{alert_id}"
211 
+        payload = {"alert_owner_id": owner_id}
212 
+        async with httpx.AsyncClient(verify=False, timeout=20.0) as client:
213 
+            response = await client.put(url, json=payload, headers=headers)
214 
+            try:
215 
+                response.raise_for_status()
216 
+            except httpx.HTTPStatusError as exc:
217 
+                detail = response.text.strip()
218 
+                raise RuntimeError(
219 
+                    f"IRIS returned {response.status_code} for {url}. Response: {detail}"
220 
+                ) from exc
221 
+            return response.json() if response.content else {"status_code": response.status_code}

+ 362 - 1
soc-integrator/app/main.py
Näytä tiedosto 

@@ -11,7 +11,9 @@ from pathlib import Path
11 11
12 12 
 from psycopg import sql
13 13 
 from fastapi import Depends, FastAPI, File, HTTPException, Request, UploadFile
14 
-from fastapi.responses import FileResponse, Response
14 
+import csv
15 
+import io
16 
+from fastapi.responses import FileResponse, Response, StreamingResponse
15 17 
 from fastapi.staticfiles import StaticFiles
16 18
17 19 
 from app.adapters.abuseipdb import AbuseIpdbAdapter
 
@@ -29,6 +31,7 @@ from app.models import (
29 31 
     CDetectionEvaluateRequest,
30 32 
     IocEnrichRequest,
31 33 
     IocEvaluateRequest,
34 
+    IrisAlertCreateRequest,
32 35 
     IrisTicketCreateRequest,
33 36 
     LogLossCheckRequest,
34 37 
     LogLossStreamCheck,
 
@@ -2299,3 +2302,361 @@ async def monitor_c_detections_state() -> ApiResponse:
2299 2302 
             "state": getattr(app.state, "c_detection_state", {}),
2300 2303 
         }
2301 2304 
     )
2305 
+
2306 
+
2307 
+# ---------------------------------------------------------------------------
2308 
+# KPI Timeout helpers and IRIS alert routes
2309 
+# ---------------------------------------------------------------------------
2310 
+
2311 
+SLA_SECONDS: dict[str, int] = {"High": 14400, "Medium": 28800, "Low": 86400}
2312 
+
2313 
+
2314 
+def compute_kpi(
2315 
+    created_at: str,
2316 
+    severity_name: str,
2317 
+    resolved_at: str | None = None,
2318 
+) -> dict[str, object]:
2319 
+    sla = SLA_SECONDS.get(severity_name, 28800)
2320 
+
2321 
+    def _parse(ts: str) -> datetime:
2322 
+        dt = datetime.fromisoformat(ts.replace("Z", "+00:00"))
2323 
+        return dt if dt.tzinfo else dt.replace(tzinfo=timezone.utc)
2324 
+
2325 
+    start = _parse(created_at)
2326 
+    thresholds = [("S1", "#22c55e", 25), ("S2", "#eab308", 50), ("S3", "#f97316", 75), ("S4", "#ef4444", 100)]
2327 
+
2328 
+    if resolved_at:
2329 
+        end = _parse(resolved_at)
2330 
+        elapsed = max(0, (end - start).total_seconds())  # clamp: close_date can't precede open_date
2331 
+        elapsed_pct = min(elapsed / sla * 100, 100)
2332 
+        kpi_pct = max(100 - elapsed_pct, 0)
2333 
+        segments = [{"label": l, "color": c, "active": elapsed_pct >= t} for l, c, t in thresholds]
2334 
+        return {
2335 
+            "kpi_pct": round(kpi_pct, 1),
2336 
+            "elapsed_pct": round(elapsed_pct, 1),
2337 
+            "status": "Resolved",
2338 
+            "segments": segments,
2339 
+            "resolved": True,
2340 
+        }
2341 
+
2342 
+    elapsed = (datetime.now(timezone.utc) - start).total_seconds()
2343 
+    elapsed_pct = min(elapsed / sla * 100, 100)
2344 
+    kpi_pct = max(100 - elapsed_pct, 0)
2345 
+    segments = [{"label": l, "color": c, "active": elapsed_pct >= t} for l, c, t in thresholds]
2346 
+    if kpi_pct >= 80:
2347 
+        status = "On Track"
2348 
+    elif kpi_pct >= 60:
2349 
+        status = "Watch"
2350 
+    elif kpi_pct >= 40:
2351 
+        status = "Warning"
2352 
+    elif kpi_pct >= 20:
2353 
+        status = "Urgent"
2354 
+    elif kpi_pct > 0:
2355 
+        status = "Critical"
2356 
+    else:
2357 
+        status = "Breached"
2358 
+    return {
2359 
+        "kpi_pct": round(kpi_pct, 1),
2360 
+        "elapsed_pct": round(elapsed_pct, 1),
2361 
+        "status": status,
2362 
+        "segments": segments,
2363 
+        "resolved": False,
2364 
+    }
2365 
+
2366 
+
2367 
+def _enrich_alerts_with_kpi(iris_response: dict) -> dict:
2368 
+    """Inject kpi field into each alert row returned by IRIS.
2369 
+
2370 
+    IRIS GET /api/v2/alerts returns: { "total": N, "data": [...], ... }
2371 
+    """
2372 
+    alerts = iris_response.get("data", [])
2373 
+    if not isinstance(alerts, list):
2374 
+        return iris_response
2375 
+    for alert in alerts:
2376 
+        created_at = alert.get("alert_creation_time") or ""
2377 
+        severity = (alert.get("severity") or {}).get("severity_name", "Medium")
2378 
+        if not created_at:
2379 
+            continue
2380 
+        resolved_at: str | None = None
2381 
+        if alert.get("alert_resolution_status_id") is not None:
2382 
+            history: dict = alert.get("modification_history") or {}
2383 
+            if history:
2384 
+                last_ts = max(history.keys(), key=lambda k: float(k))
2385 
+                resolved_at = datetime.fromtimestamp(float(last_ts), tz=timezone.utc).isoformat()
2386 
+        try:
2387 
+            alert["kpi"] = compute_kpi(created_at, severity, resolved_at)
2388 
+        except Exception:
2389 
+            alert["kpi"] = {"kpi_pct": 0, "elapsed_pct": 100, "status": "Breached", "segments": [], "resolved": False}
2390 
+    return iris_response
2391 
+
2392 
+
2393 
+def _enrich_cases_with_kpi(iris_response: dict) -> dict:
2394 
+    # v2 cases list: { "data": [...], "total": N, ... }
2395 
+    # Each case uses open_date / close_date / state.state_name / severity_id
2396 
+    _CASE_SEV: dict[int, str] = {1: "Medium", 4: "Low", 5: "High", 6: "High"}  # severity_id → name
2397 
+    cases = iris_response.get("data") or iris_response.get("items", [])
2398 
+    if not isinstance(cases, list):
2399 
+        return iris_response
2400 
+    for case in cases:
2401 
+        created_at = case.get("open_date") or ""
2402 
+        if not created_at:
2403 
+            continue
2404 
+        sev_id = case.get("severity_id") or 1
2405 
+        severity = _CASE_SEV.get(int(sev_id), "Medium")
2406 
+        resolved_at = None
2407 
+        close_date = case.get("close_date")
2408 
+        state_name = ((case.get("state") or {}).get("state_name") or "").lower()
2409 
+        if close_date:
2410 
+            resolved_at = close_date
2411 
+        elif state_name == "closed":
2412 
+            resolved_at = created_at
2413 
+        try:
2414 
+            case["kpi"] = compute_kpi(created_at, severity, resolved_at)
2415 
+        except Exception:
2416 
+            case["kpi"] = {"kpi_pct": 0, "elapsed_pct": 100, "status": "Breached", "segments": [], "resolved": False}
2417 
+    return iris_response
2418 
+
2419 
+
2420 
+@app.get(
2421 
+    "/iris/cases/export-csv",
2422 
+    summary="Export IRIS cases as CSV",
2423 
+    description="Download all cases (up to 1000) with KPI as a CSV attachment.",
2424 
+)
2425 
+async def iris_export_cases_csv() -> StreamingResponse:
2426 
+    try:
2427 
+        raw = await iris_adapter.list_cases(limit=1000, offset=0)
2428 
+    except Exception as exc:
2429 
+        raise HTTPException(status_code=502, detail=f"IRIS case export failed: {exc}") from exc
2430 
+    enriched = _enrich_cases_with_kpi(raw)
2431 
+    cases = enriched.get("data") or enriched.get("items", [])
2432 
+    _CASE_SEV: dict[int, str] = {1: "Medium", 4: "Low", 5: "High", 6: "High"}
2433 
+    output = io.StringIO()
2434 
+    fieldnames = ["case_id", "case_name", "severity", "state", "open_date", "close_date", "kpi_pct", "kpi_status"]
2435 
+    writer = csv.DictWriter(output, fieldnames=fieldnames, extrasaction="ignore")
2436 
+    writer.writeheader()
2437 
+    for case in cases:
2438 
+        kpi = case.get("kpi", {})
2439 
+        writer.writerow({
2440 
+            "case_id": case.get("case_id", ""),
2441 
+            "case_name": case.get("case_name", ""),
2442 
+            "severity": _CASE_SEV.get(int(case.get("severity_id") or 1), "Medium"),
2443 
+            "state": (case.get("state") or {}).get("state_name", ""),
2444 
+            "open_date": case.get("open_date", ""),
2445 
+            "close_date": case.get("close_date", ""),
2446 
+            "kpi_pct": kpi.get("kpi_pct", ""),
2447 
+            "kpi_status": kpi.get("status", ""),
2448 
+        })
2449 
+    output.seek(0)
2450 
+    return StreamingResponse(
2451 
+        iter([output.getvalue()]),
2452 
+        media_type="text/csv",
2453 
+        headers={"Content-Disposition": "attachment; filename=iris_cases.csv"},
2454 
+    )
2455 
+
2456 
+
2457 
+@app.get(
2458 
+    "/iris/cases/{case_id}",
2459 
+    response_model=ApiResponse,
2460 
+    summary="Get single IRIS case with KPI",
2461 
+    description="Fetch one DFIR-IRIS case by ID and annotate with computed KPI data.",
2462 
+)
2463 
+async def iris_get_case(case_id: int) -> ApiResponse:
2464 
+    try:
2465 
+        raw = await iris_adapter.get_case(case_id)
2466 
+    except Exception as exc:
2467 
+        raise HTTPException(status_code=502, detail=f"IRIS case fetch failed: {exc}") from exc
2468 
+    wrapper = {"data": [raw]}
2469 
+    enriched = _enrich_cases_with_kpi(wrapper)
2470 
+    case_out = enriched["data"][0] if enriched.get("data") else raw
2471 
+    return ApiResponse(data={"case": case_out})
2472 
+
2473 
+
2474 
+@app.get(
2475 
+    "/iris/cases",
2476 
+    response_model=ApiResponse,
2477 
+    summary="List IRIS cases with KPI",
2478 
+    description="Fetch cases from DFIR-IRIS and annotate each with computed KPI data.",
2479 
+)
2480 
+async def iris_list_cases(
2481 
+    page: int = 1,
2482 
+    per_page: int = 20,
2483 
+    sort_by: str = "case_id",
2484 
+    sort_dir: str = "desc",
2485 
+    filter_name: str | None = None,
2486 
+) -> ApiResponse:
2487 
+    # adapter maps (limit, offset) → (per_page, page) for IRIS v2
2488 
+    offset = (page - 1) * per_page
2489 
+    try:
2490 
+        raw = await iris_adapter.list_cases(limit=per_page, offset=offset)
2491 
+    except Exception as exc:
2492 
+        raise HTTPException(status_code=502, detail=f"IRIS case list failed: {exc}") from exc
2493 
+    enriched = _enrich_cases_with_kpi(raw)
2494 
+    items = enriched.get("data") or enriched.get("items", [])
2495 
+    total = enriched.get("total", len(items))
2496 
+    last_page = enriched.get("last_page", max(1, -(-total // per_page)))
2497 
+    if filter_name:
2498 
+        items = [c for c in items if filter_name.lower() in (c.get("case_name") or "").lower()]
2499 
+    reverse = sort_dir == "desc"
2500 
+    items.sort(key=lambda c: c.get(sort_by) or 0, reverse=reverse)
2501 
+    return ApiResponse(data={"cases": {
2502 
+        "data": items,
2503 
+        "total": total,
2504 
+        "current_page": page,
2505 
+        "last_page": last_page,
2506 
+    }})
2507 
+
2508 
+
2509 
+@app.post(
2510 
+    "/iris/alerts",
2511 
+    response_model=ApiResponse,
2512 
+    summary="Create IRIS alert",
2513 
+    description="Create a new alert in DFIR-IRIS via /api/v2/alerts.",
2514 
+)
2515 
+async def iris_create_alert(payload: IrisAlertCreateRequest) -> ApiResponse:
2516 
+    alert_payload: dict[str, Any] = {
2517 
+        "alert_title": payload.title,
2518 
+        "alert_description": payload.description,
2519 
+        "alert_severity_id": payload.severity_id,
2520 
+        "alert_status_id": payload.status_id,
2521 
+        "alert_source": payload.source,
2522 
+        "alert_customer_id": payload.customer_id or settings.iris_default_customer_id,
2523 
+        "alert_source_event_time": datetime.now(timezone.utc).isoformat(),
2524 
+    }
2525 
+    if payload.source_ref:
2526 
+        alert_payload["alert_source_ref"] = payload.source_ref
2527 
+    if payload.payload:
2528 
+        alert_payload.update(payload.payload)
2529 
+    try:
2530 
+        result = await iris_adapter.create_alert(alert_payload)
2531 
+    except Exception as exc:
2532 
+        raise HTTPException(status_code=502, detail=f"IRIS alert create failed: {exc}") from exc
2533 
+    return ApiResponse(data={"alert": result})
2534 
+
2535 
+
2536 
+@app.get(
2537 
+    "/iris/alerts",
2538 
+    response_model=ApiResponse,
2539 
+    summary="List IRIS alerts with KPI Timeout",
2540 
+    description="Fetch alerts from DFIR-IRIS and annotate each row with computed KPI Timeout data.",
2541 
+)
2542 
+async def iris_list_alerts(
2543 
+    page: int = 1,
2544 
+    per_page: int = 20,
2545 
+    sort_by: str = "alert_id",
2546 
+    sort_dir: str = "desc",
2547 
+    filter_title: str | None = None,
2548 
+    filter_owner_id: int | None = None,
2549 
+) -> ApiResponse:
2550 
+    try:
2551 
+        raw = await iris_adapter.list_alerts(
2552 
+            page=page,
2553 
+            per_page=per_page,
2554 
+            sort_by=sort_by,
2555 
+            sort_dir=sort_dir,
2556 
+            filter_title=filter_title,
2557 
+            filter_owner_id=filter_owner_id,
2558 
+        )
2559 
+        enriched = _enrich_alerts_with_kpi(raw)
2560 
+        return ApiResponse(data={
2561 
+            "alerts": {
2562 
+                "data": enriched.get("data", []),
2563 
+                "total": enriched.get("total", 0),
2564 
+                "current_page": enriched.get("current_page", page),
2565 
+                "last_page": enriched.get("last_page", 1),
2566 
+            }
2567 
+        })
2568 
+    except Exception as exc:
2569 
+        raise HTTPException(status_code=502, detail=f"IRIS alert list failed: {exc}") from exc
2570 
+
2571 
+
2572 
+@app.get(
2573 
+    "/iris/alerts/export-csv",
2574 
+    summary="Export IRIS alerts as CSV",
2575 
+    description="Download all matching alerts (up to 1000) as a CSV attachment.",
2576 
+)
2577 
+async def iris_export_alerts_csv(
2578 
+    sort_by: str = "alert_id",
2579 
+    sort_dir: str = "desc",
2580 
+    filter_title: str | None = None,
2581 
+    filter_owner_id: int | None = None,
2582 
+) -> StreamingResponse:
2583 
+    try:
2584 
+        raw = await iris_adapter.list_alerts(
2585 
+            page=1,
2586 
+            per_page=1000,
2587 
+            sort_by=sort_by,
2588 
+            sort_dir=sort_dir,
2589 
+            filter_title=filter_title,
2590 
+            filter_owner_id=filter_owner_id,
2591 
+        )
2592 
+    except Exception as exc:
2593 
+        raise HTTPException(status_code=502, detail=f"IRIS alert export failed: {exc}") from exc
2594 
+
2595 
+    enriched = _enrich_alerts_with_kpi(raw)
2596 
+    alerts = enriched.get("data", [])
2597 
+
2598 
+    output = io.StringIO()
2599 
+    fieldnames = [
2600 
+        "alert_id", "alert_title", "alert_severity", "alert_status",
2601 
+        "alert_creation_time", "alert_source_event_time", "alert_owner",
2602 
+        "kpi_pct", "kpi_status",
2603 
+    ]
2604 
+    writer = csv.DictWriter(output, fieldnames=fieldnames, extrasaction="ignore")
2605 
+    writer.writeheader()
2606 
+    for alert in alerts:
2607 
+        kpi = alert.get("kpi", {})
2608 
+        severity_name = (alert.get("severity") or {}).get("severity_name", "")
2609 
+        writer.writerow({
2610 
+            "alert_id": alert.get("alert_id", ""),
2611 
+            "alert_title": alert.get("alert_title", ""),
2612 
+            "alert_severity": severity_name,
2613 
+            "alert_status": (alert.get("status") or {}).get("status_name", ""),
2614 
+            "alert_creation_time": alert.get("alert_creation_time", ""),
2615 
+            "alert_source_event_time": alert.get("alert_source_event_time", ""),
2616 
+            "alert_owner": (alert.get("owner") or {}).get("user_name", ""),
2617 
+            "kpi_pct": kpi.get("kpi_pct", ""),
2618 
+            "kpi_status": kpi.get("status", ""),
2619 
+        })
2620 
+
2621 
+    output.seek(0)
2622 
+    return StreamingResponse(
2623 
+        iter([output.getvalue()]),
2624 
+        media_type="text/csv",
2625 
+        headers={"Content-Disposition": "attachment; filename=iris_alerts.csv"},
2626 
+    )
2627 
+
2628 
+
2629 
+@app.get(
2630 
+    "/iris/alerts/{alert_id}",
2631 
+    response_model=ApiResponse,
2632 
+    summary="Get single IRIS alert with KPI",
2633 
+    description="Fetch one DFIR-IRIS alert by ID and annotate with computed KPI data.",
2634 
+)
2635 
+async def iris_get_alert(alert_id: int) -> ApiResponse:
2636 
+    try:
2637 
+        raw = await iris_adapter.get_alert(alert_id)
2638 
+    except Exception as exc:
2639 
+        raise HTTPException(status_code=502, detail=f"IRIS alert fetch failed: {exc}") from exc
2640 
+    # Wrap in list-shaped dict so _enrich_alerts_with_kpi can process it
2641 
+    alert = raw if isinstance(raw, dict) else {}
2642 
+    wrapper = {"data": [alert]}
2643 
+    enriched = _enrich_alerts_with_kpi(wrapper)
2644 
+    alert_out = enriched["data"][0] if enriched.get("data") else alert
2645 
+    return ApiResponse(data={"alert": alert_out})
2646 
+
2647 
+
2648 
+@app.post(
2649 
+    "/iris/alerts/{alert_id}/assign",
2650 
+    response_model=ApiResponse,
2651 
+    summary="Assign IRIS alert to owner",
2652 
+    description="Update the owner of a DFIR-IRIS alert.",
2653 
+)
2654 
+async def iris_assign_alert(alert_id: int, body: dict) -> ApiResponse:
2655 
+    owner_id = body.get("owner_id")
2656 
+    if not isinstance(owner_id, int):
2657 
+        raise HTTPException(status_code=422, detail="owner_id must be an integer")
2658 
+    try:
2659 
+        result = await iris_adapter.assign_alert(alert_id=alert_id, owner_id=owner_id)
2660 
+        return ApiResponse(data=result)
2661 
+    except Exception as exc:
2662 
+        raise HTTPException(status_code=502, detail=f"IRIS alert assign failed: {exc}") from exc

+ 26 - 0
soc-integrator/app/models.py
Näytä tiedosto 

@@ -355,6 +355,32 @@ class SimLogRunRequest(BaseModel):
355 355 
     forever: bool = Field(default=False, description="Run continuously until stopped.", examples=[False])
356 356
357 357
358 
+class IrisAlertCreateRequest(BaseModel):
359 
+    model_config = ConfigDict(
360 
+        json_schema_extra={
361 
+            "example": {
362 
+                "title": "Suspicious login detected",
363 
+                "description": "Multiple failed logins followed by success from unusual IP",
364 
+                "severity_id": 4,
365 
+                "status_id": 2,
366 
+                "source": "wazuh",
367 
+                "source_ref": "wazuh-alert-12345",
368 
+                "customer_id": 1,
369 
+                "payload": {"alert_tags": "brute-force,authentication"},
370 
+            }
371 
+        }
372 
+    )
373 
+
374 
+    title: str = Field(description="Alert title.", examples=["Suspicious login detected"])
375 
+    description: str = Field(default="Created by soc-integrator", description="Alert description.")
376 
+    severity_id: int = Field(default=3, description="IRIS severity ID (1=Info,2=Low,3=Medium,4=High,5=Critical).", examples=[4])
377 
+    status_id: int = Field(default=2, description="IRIS alert status ID.", examples=[2])
378 
+    source: str = Field(default="soc-integrator", description="Alert source name.", examples=["wazuh"])
379 
+    source_ref: str | None = Field(default=None, description="Source-system reference ID.", examples=["wazuh-alert-12345"])
380 
+    customer_id: int | None = Field(default=None, description="IRIS customer ID (defaults to configured value).")
381 
+    payload: dict[str, Any] = Field(default_factory=dict, description="Additional IRIS alert fields merged into the request.")
382 
+
383 
+
358 384 
 class ApiResponse(BaseModel):
359 385 
     ok: bool = True
360 386 
     message: str = "ok"

tum/whitesports - Gogs: Simplico Git Service
Página Inicial Explorar Ajuda
Entrar
tum
/
whitesports
Observar 1
Favorito 0
Fork 0
Código Problemas 0 Pull Requests 0 Commits 5 Versões 0 Wiki

Nenhuma Descrição

Árvore: 0b697c9ce1
Branches Tags
whitesports
/
app
/
wp-content
/
plugins
/
jetpack
/
class.jetpac...

class.jetpack-cli.php 69KB
Histórico Cru

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092 
  1. <?php
    2. 

  2. 

  3. use Automattic\Jetpack\Connection\Client;
    4. 

  4. use Automattic\Jetpack\Connection\Manager as Connection_Manager;
    5. 

  5. use Automattic\Jetpack\Connection\Tokens;
    6. 

  6. use Automattic\Jetpack\Identity_Crisis;
    7. 

  7. use Automattic\Jetpack\Status;
    8. 

  8. use Automattic\Jetpack\Sync\Actions;
    9. 

  9. use Automattic\Jetpack\Sync\Listener;
    10. 

  10. use Automattic\Jetpack\Sync\Modules;
    11. 

  11. use Automattic\Jetpack\Sync\Queue;
    12. 

  12. use Automattic\Jetpack\Sync\Settings;
    13. 

  13. 

  14. WP_CLI::add_command( 'jetpack', 'Jetpack_CLI' );
    15. 

  15. 

  16. /**
    17. 

  17.  * Control your local Jetpack installation.
    18. 

  18.  */
    19. 

  19. class Jetpack_CLI extends WP_CLI_Command {
    20. 

  20. 	// Aesthetics.
    21. 

  21. 	public $green_open  = "\033[32m";
    22. 

  22. 	public $red_open    = "\033[31m";
    23. 

  23. 	public $yellow_open = "\033[33m";
    24. 

  24. 	public $color_close = "\033[0m";
    25. 

  25. 

  26. 	/**
    27. 

  27. 	 * Get Jetpack Details
    28. 

  28. 	 *
    29. 

  29. 	 * ## OPTIONS
    30. 

  30. 	 *
    31. 

  31. 	 * empty: Leave it empty for basic stats
    32. 

  32. 	 *
    33. 

  33. 	 * full: View full stats.  It's the data from the heartbeat
    34. 

  34. 	 *
    35. 

  35. 	 * ## EXAMPLES
    36. 

  36. 	 *
    37. 

  37. 	 * wp jetpack status
    38. 

  38. 	 * wp jetpack status full
    39. 

  39. 	 */
    40. 

  40. 	public function status( $args, $assoc_args ) {
    41. 

  41. 		jetpack_require_lib( 'debugger' );
    42. 

  42. 

  43. 		/* translators: %s is the site URL */
    44. 

  44. 		WP_CLI::line( sprintf( __( 'Checking status for %s', 'jetpack' ), esc_url( get_home_url() ) ) );
    45. 

  45. 

  46. 		if ( isset( $args[0] ) && 'full' !== $args[0] ) {
    47. 

  47. 			/* translators: %s is a command like "prompt" */
    48. 

  48. 			WP_CLI::error( sprintf( __( '%s is not a valid command.', 'jetpack' ), $args[0] ) );
    49. 

  49. 		}
    50. 

  50. 

  51. 		$master_user_email = Jetpack::get_master_user_email();
    52. 

  52. 

  53. 		$cxntests = new Jetpack_Cxn_Tests();
    54. 

  54. 

  55. 		if ( $cxntests->pass() ) {
    56. 

  56. 			$cxntests->output_results_for_cli();
    57. 

  57. 

  58. 			WP_CLI::success( __( 'Jetpack is currently connected to WordPress.com', 'jetpack' ) );
    59. 

  59. 		} else {
    60. 

  60. 			$error = array();
    61. 

  61. 			foreach ( $cxntests->list_fails() as $fail ) {
    62. 

  62. 				$error[] = $fail['name'] . ': ' . $fail['message'];
    63. 

  63. 			}
    64. 

  64. 			WP_CLI::error_multi_line( $error );
    65. 

  65. 

  66. 			$cxntests->output_results_for_cli();
    67. 

  67. 

  68. 			WP_CLI::error( __( 'One or more tests did not pass. Please investigate!', 'jetpack' ) ); // Exit CLI.
    69. 

  69. 		}
    70. 

  70. 

  71. 		/* translators: %s is current version of Jetpack, for example 7.3 */
    72. 

  72. 		WP_CLI::line( sprintf( __( 'The Jetpack Version is %s', 'jetpack' ), JETPACK__VERSION ) );
    73. 

  73. 		/* translators: %d is WP.com ID of this blog */
    74. 

  74. 		WP_CLI::line( sprintf( __( 'The WordPress.com blog_id is %d', 'jetpack' ), Jetpack_Options::get_option( 'id' ) ) );
    75. 

  75. 		/* translators: %s is the email address of the connection owner */
    76. 

  76. 		WP_CLI::line( sprintf( __( 'The WordPress.com account for the primary connection is %s', 'jetpack' ), $master_user_email ) );
    77. 

  77. 

  78. 		/*
    79. 

  79. 		 * Are they asking for all data?
    80. 

  80. 		 *
    81. 

  81. 		 * Loop through heartbeat data and organize by priority.
    82. 

  82. 		 */
    83. 

  83. 		$all_data = ( isset( $args[0] ) && 'full' == $args[0] ) ? 'full' : false;
    84. 

  84. 		if ( $all_data ) {
    85. 

  85. 			// Heartbeat data
    86. 

  86. 			WP_CLI::line( "\n" . __( 'Additional data: ', 'jetpack' ) );
    87. 

  87. 

  88. 			// Get the filtered heartbeat data.
    89. 

  89. 			// Filtered so we can color/list by severity
    90. 

  90. 			$stats = Jetpack::jetpack_check_heartbeat_data();
    91. 

  91. 

  92. 			// Display red flags first
    93. 

  93. 			foreach ( $stats['bad'] as $stat => $value ) {
    94. 

  94. 				printf( "$this->red_open%-'.16s %s $this->color_close\n", $stat, $value );
    95. 

  95. 			}
    96. 

  96. 

  97. 			// Display caution warnings next
    98. 

  98. 			foreach ( $stats['caution'] as $stat => $value ) {
    99. 

  99. 				printf( "$this->yellow_open%-'.16s %s $this->color_close\n", $stat, $value );
    100. 

  100. 			}
    101. 

  101. 

  102. 			// The rest of the results are good!
    103. 

  103. 			foreach ( $stats['good'] as $stat => $value ) {
    104. 

  104. 

  105. 				// Modules should get special spacing for aestetics
    106. 

  106. 				if ( strpos( $stat, 'odule-' ) ) {
    107. 

  107. 					printf( "%-'.30s %s\n", $stat, $value );
    108. 

  108. 					usleep( 4000 ); // For dramatic effect lolz
    109. 

  109. 					continue;
    110. 

  110. 				}
    111. 

  111. 				printf( "%-'.16s %s\n", $stat, $value );
    112. 

  112. 				usleep( 4000 ); // For dramatic effect lolz
    113. 

  113. 			}
    114. 

  114. 		} else {
    115. 

  115. 			// Just the basics
    116. 

  116. 			WP_CLI::line( "\n" . _x( "View full status with 'wp jetpack status full'", '"wp jetpack status full" is a command - do not translate', 'jetpack' ) );
    117. 

  117. 		}
    118. 

  118. 	}
    119. 

  119. 

  120. 	/**
    121. 

  121. 	 * Tests the active connection
    122. 

  122. 	 *
    123. 

  123. 	 * Does a two-way test to verify that the local site can communicate with remote Jetpack/WP.com servers and that Jetpack/WP.com servers can talk to the local site.
    124. 

  124. 	 *
    125. 

  125. 	 * ## EXAMPLES
    126. 

  126. 	 *
    127. 

  127. 	 * wp jetpack test-connection
    128. 

  128. 	 *
    129. 

  129. 	 * @subcommand test-connection
    130. 

  130. 	 */
    131. 

  131. 	public function test_connection( $args, $assoc_args ) {
    132. 

  132. 

  133. 		/* translators: %s is the site URL */
    134. 

  134. 		WP_CLI::line( sprintf( __( 'Testing connection for %s', 'jetpack' ), esc_url( get_site_url() ) ) );
    135. 

  135. 

  136. 		if ( ! Jetpack::is_connection_ready() ) {
    137. 

  137. 			WP_CLI::error( __( 'Jetpack is not currently connected to WordPress.com', 'jetpack' ) );
    138. 

  138. 		}
    139. 

  139. 

  140. 		$response = Client::wpcom_json_api_request_as_blog(
    141. 

  141. 			sprintf( '/jetpack-blogs/%d/test-connection', Jetpack_Options::get_option( 'id' ) ),
    142. 

  142. 			Client::WPCOM_JSON_API_VERSION
    143. 

  143. 		);
    144. 

  144. 

  145. 		if ( is_wp_error( $response ) ) {
    146. 

  146. 			/* translators: %1$s is the error code, %2$s is the error message */
    147. 

  147. 			WP_CLI::error( sprintf( __( 'Failed to test connection (#%1$s: %2$s)', 'jetpack' ), $response->get_error_code(), $response->get_error_message() ) );
    148. 

  148. 		}
    149. 

  149. 

  150. 		$body = wp_remote_retrieve_body( $response );
    151. 

  151. 		if ( ! $body ) {
    152. 

  152. 			WP_CLI::error( __( 'Failed to test connection (empty response body)', 'jetpack' ) );
    153. 

  153. 		}
    154. 

  154. 

  155. 		$result       = json_decode( $body );
    156. 

  156. 		$is_connected = (bool) $result->connected;
    157. 

  157. 		$message      = $result->message;
    158. 

  158. 

  159. 		if ( $is_connected ) {
    160. 

  160. 			WP_CLI::success( $message );
    161. 

  161. 		} else {
    162. 

  162. 			WP_CLI::error( $message );
    163. 

  163. 		}
    164. 

  164. 	}
    165. 

  165. 

  166. 	/**
    167. 

  167. 	 * Disconnect Jetpack Blogs or Users
    168. 

  168. 	 *
    169. 

  169. 	 * ## OPTIONS
    170. 

  170. 	 *
    171. 

  171. 	 * blog: Disconnect the entire blog.
    172. 

  172. 	 *
    173. 

  173. 	 * user <user_identifier>: Disconnect a specific user from WordPress.com.
    174. 

  174. 	 *
    175. 

  175. 	 * [--force]
    176. 

  176. 	 * If the user ID provided is the connection owner, it will only be disconnected if --force is passed
    177. 

  177. 	 *
    178. 

  178. 	 * ## EXAMPLES
    179. 

  179. 	 *
    180. 

  180. 	 * wp jetpack disconnect blog
    181. 

  181. 	 * wp jetpack disconnect user 13
    182. 

  182. 	 * wp jetpack disconnect user 1 --force
    183. 

  183. 	 * wp jetpack disconnect user username
    184. 

  184. 	 * wp jetpack disconnect user email@domain.com
    185. 

  185. 	 *
    186. 

  186. 	 * @synopsis <blog|user> [<user_identifier>] [--force]
    187. 

  187. 	 */
    188. 

  188. 	public function disconnect( $args, $assoc_args ) {
    189. 

  189. 		if ( ! Jetpack::is_connection_ready() ) {
    190. 

  190. 			WP_CLI::success( __( 'The site is not currently connected, so nothing to do!', 'jetpack' ) );
    191. 

  191. 			return;
    192. 

  192. 		}
    193. 

  193. 

  194. 		$action = isset( $args[0] ) ? $args[0] : 'prompt';
    195. 

  195. 		if ( ! in_array( $action, array( 'blog', 'user', 'prompt' ) ) ) {
    196. 

  196. 			/* translators: %s is a command like "prompt" */
    197. 

  197. 			WP_CLI::error( sprintf( __( '%s is not a valid command.', 'jetpack' ), $action ) );
    198. 

  198. 		}
    199. 

  199. 

  200. 		if ( in_array( $action, array( 'user' ) ) ) {
    201. 

  201. 			if ( isset( $args[1] ) ) {
    202. 

  202. 				$user_id = $args[1];
    203. 

  203. 				if ( ctype_digit( $user_id ) ) {
    204. 

  204. 					$field   = 'id';
    205. 

  205. 					$user_id = (int) $user_id;
    206. 

  206. 				} elseif ( is_email( $user_id ) ) {
    207. 

  207. 					$field   = 'email';
    208. 

  208. 					$user_id = sanitize_user( $user_id, true );
    209. 

  209. 				} else {
    210. 

  210. 					$field   = 'login';
    211. 

  211. 					$user_id = sanitize_user( $user_id, true );
    212. 

  212. 				}
    213. 

  213. 				if ( ! $user = get_user_by( $field, $user_id ) ) {
    214. 

  214. 					WP_CLI::error( __( 'Please specify a valid user.', 'jetpack' ) );
    215. 

  215. 				}
    216. 

  216. 			} else {
    217. 

  217. 				WP_CLI::error( __( 'Please specify a user by either ID, username, or email.', 'jetpack' ) );
    218. 

  218. 			}
    219. 

  219. 		}
    220. 

  220. 

  221. 		$force_user_disconnect = ! empty( $assoc_args['force'] );
    222. 

  222. 

  223. 		switch ( $action ) {
    224. 

  224. 			case 'blog':
    225. 

  225. 				Jetpack::log( 'disconnect' );
    226. 

  226. 				Jetpack::disconnect();
    227. 

  227. 				WP_CLI::success(
    228. 

  228. 					sprintf(
    229. 

  229. 						/* translators: %s is the site URL */
    230. 

  230. 						__( 'Jetpack has been successfully disconnected for %s.', 'jetpack' ),
    231. 

  231. 						esc_url( get_site_url() )
    232. 

  232. 					)
    233. 

  233. 				);
    234. 

  234. 				break;
    235. 

  235. 			case 'user':
    236. 

  236. 				$connection_manager = new Connection_Manager( 'jetpack' );
    237. 

  237. 				$disconnected       = $connection_manager->disconnect_user( $user->ID, $force_user_disconnect );
    238. 

  238. 				if ( $disconnected ) {
    239. 

  239. 					Jetpack::log( 'unlink', $user->ID );
    240. 

  240. 					WP_CLI::success( __( 'User has been successfully disconnected.', 'jetpack' ) );
    241. 

  241. 				} else {
    242. 

  242. 					if ( ! $connection_manager->is_user_connected( $user->ID ) ) {
    243. 

  243. 						/* translators: %s is a username */
    244. 

  244. 						$error_message = sprintf( __( 'User %s could not be disconnected because it is not connected!', 'jetpack' ), "{$user->data->user_login} <{$user->data->user_email}>" );
    245. 

  245. 					} elseif ( ! $force_user_disconnect && $connection_manager->is_connection_owner( $user->ID ) ) {
    246. 

  246. 						/* translators: %s is a username */
    247. 

  247. 						$error_message = sprintf( __( 'User %s could not be disconnected because it is the connection owner! If you want to disconnect in anyway, use the --force parameter.', 'jetpack' ), "{$user->data->user_login} <{$user->data->user_email}>" );
    248. 

  248. 					} else {
    249. 

  249. 						/* translators: %s is a username */
    250. 

  250. 						$error_message = sprintf( __( 'User %s could not be disconnected.', 'jetpack' ), "{$user->data->user_login} <{$user->data->user_email}>" );
    251. 

  251. 					}
    252. 

  252. 					WP_CLI::error( $error_message );
    253. 

  253. 				}
    254. 

  254. 				break;
    255. 

  255. 			case 'prompt':
    256. 

  256. 				WP_CLI::error( __( 'Please specify if you would like to disconnect a blog or user.', 'jetpack' ) );
    257. 

  257. 				break;
    258. 

  258. 		}
    259. 

  259. 	}
    260. 

  260. 

  261. 	/**
    262. 

  262. 	 * Reset Jetpack options and settings to default
    263. 

  263. 	 *
    264. 

  264. 	 * ## OPTIONS
    265. 

  265. 	 *
    266. 

  266. 	 * modules: Resets modules to default state ( get_default_modules() )
    267. 

  267. 	 *
    268. 

  268. 	 * options: Resets all Jetpack options except:
    269. 

  269. 	 *  - All private options (Blog token, user token, etc...)
    270. 

  270. 	 *  - id (The Client ID/WP.com Blog ID of this site)
    271. 

  271. 	 *  - master_user
    272. 

  272. 	 *  - version
    273. 

  273. 	 *  - activated
    274. 

  274. 	 *
    275. 

  275. 	 * ## EXAMPLES
    276. 

  276. 	 *
    277. 

  277. 	 * wp jetpack reset options
    278. 

  278. 	 * wp jetpack reset modules
    279. 

  279. 	 * wp jetpack reset sync-checksum --dry-run --offset=0
    280. 

  280. 	 *
    281. 

  281. 	 * @synopsis <modules|options|sync-checksum> [--dry-run] [--offset=<offset>]
    282. 

  282. 	 */
    283. 

  283. 	public function reset( $args, $assoc_args ) {
    284. 

  284. 		$action = isset( $args[0] ) ? $args[0] : 'prompt';
    285. 

  285. 		if ( ! in_array( $action, array( 'options', 'modules', 'sync-checksum' ), true ) ) {
    286. 

  286. 			/* translators: %s is a command like "prompt" */
    287. 

  287. 			WP_CLI::error( sprintf( __( '%s is not a valid command.', 'jetpack' ), $action ) );
    288. 

  288. 		}
    289. 

  289. 

  290. 		$is_dry_run = ! empty( $assoc_args['dry-run'] );
    291. 

  291. 

  292. 		if ( $is_dry_run ) {
    293. 

  293. 			WP_CLI::warning(
    294. 

  294. 				__( "\nThis is a dry run.\n", 'jetpack' ) .
    295. 

  295. 				__( "No actions will be taken.\n", 'jetpack' ) .
    296. 

  296. 				__( "The following messages will give you preview of what will happen when you run this command.\n\n", 'jetpack' )
    297. 

  297. 			);
    298. 

  298. 		} else {
    299. 

  299. 			// We only need to confirm "Are you sure?" when we are not doing a dry run.
    300. 

  300. 			jetpack_cli_are_you_sure();
    301. 

  301. 		}
    302. 

  302. 

  303. 		switch ( $action ) {
    304. 

  304. 			case 'options':
    305. 

  305. 				$options_to_reset = Jetpack_Options::get_options_for_reset();
    306. 

  306. 				// Reset the Jetpack options
    307. 

  307. 				WP_CLI::line(
    308. 

  308. 					sprintf(
    309. 

  309. 						/* translators: %s is the site URL */
    310. 

  310. 						__( "Resetting Jetpack Options for %s...\n", 'jetpack' ),
    311. 

  311. 						esc_url( get_site_url() )
    312. 

  312. 					)
    313. 

  313. 				);
    314. 

  314. 				sleep( 1 ); // Take a breath
    315. 

  315. 				foreach ( $options_to_reset['jp_options'] as $option_to_reset ) {
    316. 

  316. 					if ( ! $is_dry_run ) {
    317. 

  317. 						Jetpack_Options::delete_option( $option_to_reset );
    318. 

  318. 						usleep( 100000 );
    319. 

  319. 					}
    320. 

  320. 

  321. 					/* translators: This is the result of an action. The option named %s was reset */
    322. 

  322. 					WP_CLI::success( sprintf( __( '%s option reset', 'jetpack' ), $option_to_reset ) );
    323. 

  323. 				}
    324. 

  324. 

  325. 				// Reset the WP options
    326. 

  326. 				WP_CLI::line( __( "Resetting the jetpack options stored in wp_options...\n", 'jetpack' ) );
    327. 

  327. 				usleep( 500000 ); // Take a breath
    328. 

  328. 				foreach ( $options_to_reset['wp_options'] as $option_to_reset ) {
    329. 

  329. 					if ( ! $is_dry_run ) {
    330. 

  330. 						delete_option( $option_to_reset );
    331. 

  331. 						usleep( 100000 );
    332. 

  332. 					}
    333. 

  333. 					/* translators: This is the result of an action. The option named %s was reset */
    334. 

  334. 					WP_CLI::success( sprintf( __( '%s option reset', 'jetpack' ), $option_to_reset ) );
    335. 

  335. 				}
    336. 

  336. 

  337. 				// Reset to default modules
    338. 

  338. 				WP_CLI::line( __( "Resetting default modules...\n", 'jetpack' ) );
    339. 

  339. 				usleep( 500000 ); // Take a breath
    340. 

  340. 				$default_modules = Jetpack::get_default_modules();
    341. 

  341. 				if ( ! $is_dry_run ) {
    342. 

  342. 					Jetpack::update_active_modules( $default_modules );
    343. 

  343. 				}
    344. 

  344. 				WP_CLI::success( __( 'Modules reset to default.', 'jetpack' ) );
    345. 

  345. 				break;
    346. 

  346. 			case 'modules':
    347. 

  347. 				if ( ! $is_dry_run ) {
    348. 

  348. 					$default_modules = Jetpack::get_default_modules();
    349. 

  349. 					Jetpack::update_active_modules( $default_modules );
    350. 

  350. 				}
    351. 

  351. 

  352. 				WP_CLI::success( __( 'Modules reset to default.', 'jetpack' ) );
    353. 

  353. 				break;
    354. 

  354. 			case 'prompt':
    355. 

  355. 				WP_CLI::error( __( 'Please specify if you would like to reset your options, modules or sync-checksum', 'jetpack' ) );
    356. 

  356. 				break;
    357. 

  357. 			case 'sync-checksum':
    358. 

  358. 				$option = 'jetpack_callables_sync_checksum';
    359. 

  359. 

  360. 				if ( is_multisite() ) {
    361. 

  361. 					$offset = isset( $assoc_args['offset'] ) ? (int) $assoc_args['offset'] : 0;
    362. 

  362. 

  363. 					/*
    364. 

  364. 					 * 1000 is a good limit since we don't expect the number of sites to be more than 1000
    365. 

  365. 					 * Offset can be used to paginate and try to clean up more sites.
    366. 

  366. 					 */
    367. 

  367. 					$sites       = get_sites(
    368. 

  368. 						array(
    369. 

  369. 							'number' => 1000,
    370. 

  370. 							'offset' => $offset,
    371. 

  371. 						)
    372. 

  372. 					);
    373. 

  373. 					$count_fixes = 0;
    374. 

  374. 					foreach ( $sites as $site ) {
    375. 

  375. 						switch_to_blog( $site->blog_id );
    376. 

  376. 						$count = self::count_option( $option );
    377. 

  377. 						if ( $count > 1 ) {
    378. 

  378. 							if ( ! $is_dry_run ) {
    379. 

  379. 								delete_option( $option );
    380. 

  380. 							}
    381. 

  381. 							WP_CLI::line(
    382. 

  382. 								sprintf(
    383. 

  383. 									/* translators: %1$d is a number, %2$s is the name of an option, %2$s is the site URL. */
    384. 

  384. 									__( 'Deleted %1$d %2$s options from %3$s', 'jetpack' ),
    385. 

  385. 									$count,
    386. 

  386. 									$option,
    387. 

  387. 									"{$site->domain}{$site->path}"
    388. 

  388. 								)
    389. 

  389. 							);
    390. 

  390. 							$count_fixes++;
    391. 

  391. 							if ( ! $is_dry_run ) {
    392. 

  392. 								/*
    393. 

  393. 								 * We could be deleting a lot of options rows at the same time.
    394. 

  394. 								 * Allow some time for replication to catch up.
    395. 

  395. 								 */
    396. 

  396. 								sleep( 3 );
    397. 

  397. 							}
    398. 

  398. 						}
    399. 

  399. 

  400. 						restore_current_blog();
    401. 

  401. 					}
    402. 

  402. 					if ( $count_fixes ) {
    403. 

  403. 						WP_CLI::success(
    404. 

  404. 							sprintf(
    405. 

  405. 								/* translators: %1$s is the name of an option, %2$d is a number of sites. */
    406. 

  406. 								__( 'Successfully reset %1$s on %2$d sites.', 'jetpack' ),
    407. 

  407. 								$option,
    408. 

  408. 								$count_fixes
    409. 

  409. 							)
    410. 

  410. 						);
    411. 

  411. 					} else {
    412. 

  412. 						WP_CLI::success( __( 'No options were deleted.', 'jetpack' ) );
    413. 

  413. 					}
    414. 

  414. 					return;
    415. 

  415. 				}
    416. 

  416. 

  417. 				$count = self::count_option( $option );
    418. 

  418. 				if ( $count > 1 ) {
    419. 

  419. 					if ( ! $is_dry_run ) {
    420. 

  420. 						delete_option( $option );
    421. 

  421. 					}
    422. 

  422. 					WP_CLI::success(
    423. 

  423. 						sprintf(
    424. 

  424. 							/* translators: %1$d is a number, %2$s is the name of an option. */
    425. 

  425. 							__( 'Deleted %1$d %2$s options', 'jetpack' ),
    426. 

  426. 							$count,
    427. 

  427. 							$option
    428. 

  428. 						)
    429. 

  429. 					);
    430. 

  430. 					return;
    431. 

  431. 				}
    432. 

  432. 

  433. 				WP_CLI::success( __( 'No options were deleted.', 'jetpack' ) );
    434. 

  434. 				break;
    435. 

  435. 

  436. 		}
    437. 

  437. 	}
    438. 

  438. 

  439. 	/**
    440. 

  440. 	 * Return the number of times an option appears
    441. 

  441. 	 * Normally an option would only appear 1 since the option key is supposed to be unique
    442. 

  442. 	 * but if a site hasn't updated the DB schema then that would not be the case.
    443. 

  443. 	 *
    444. 

  444. 	 * @param string $option Option name.
    445. 

  445. 	 *
    446. 

  446. 	 * @return int
    447. 

  447. 	 */
    448. 

  448. 	private static function count_option( $option ) {
    449. 

  449. 		global $wpdb;
    450. 

  450. 		return (int) $wpdb->get_var(
    451. 

  451. 			$wpdb->prepare(
    452. 

  452. 				"SELECT COUNT(*) FROM $wpdb->options WHERE option_name = %s",
    453. 

  453. 				$option
    454. 

  454. 			)
    455. 

  455. 		);
    456. 

  456. 

  457. 	}
    458. 

  458. 

  459. 	/**
    460. 

  460. 	 * Manage Jetpack Modules
    461. 

  461. 	 *
    462. 

  462. 	 * ## OPTIONS
    463. 

  463. 	 *
    464. 

  464. 	 * <list|activate|deactivate|toggle>
    465. 

  465. 	 * : The action to take.
    466. 

  466. 	 * ---
    467. 

  467. 	 * default: list
    468. 

  468. 	 * options:
    469. 

  469. 	 *  - list
    470. 

  470. 	 *  - activate
    471. 

  471. 	 *  - deactivate
    472. 

  472. 	 *  - toggle
    473. 

  473. 	 * ---
    474. 

  474. 	 *
    475. 

  475. 	 * [<module_slug>]
    476. 

  476. 	 * : The slug of the module to perform an action on.
    477. 

  477. 	 *
    478. 

  478. 	 * [--format=<format>]
    479. 

  479. 	 * : Allows overriding the output of the command when listing modules.
    480. 

  480. 	 * ---
    481. 

  481. 	 * default: table
    482. 

  482. 	 * options:
    483. 

  483. 	 *  - table
    484. 

  484. 	 *  - json
    485. 

  485. 	 *  - csv
    486. 

  486. 	 *  - yaml
    487. 

  487. 	 *  - ids
    488. 

  488. 	 *  - count
    489. 

  489. 	 * ---
    490. 

  490. 	 *
    491. 

  491. 	 * ## EXAMPLES
    492. 

  492. 	 *
    493. 

  493. 	 * wp jetpack module list
    494. 

  494. 	 * wp jetpack module list --format=json
    495. 

  495. 	 * wp jetpack module activate stats
    496. 

  496. 	 * wp jetpack module deactivate stats
    497. 

  497. 	 * wp jetpack module toggle stats
    498. 

  498. 	 * wp jetpack module activate all
    499. 

  499. 	 * wp jetpack module deactivate all
    500. 

  500. 	 */
    501. 

  501. 	public function module( $args, $assoc_args ) {
    502. 

  502. 		$action = isset( $args[0] ) ? $args[0] : 'list';
    503. 

  503. 

  504. 		if ( isset( $args[1] ) ) {
    505. 

  505. 			$module_slug = $args[1];
    506. 

  506. 			if ( 'all' !== $module_slug && ! Jetpack::is_module( $module_slug ) ) {
    507. 

  507. 				/* translators: %s is a module slug like "stats" */
    508. 

  508. 				WP_CLI::error( sprintf( __( '%s is not a valid module.', 'jetpack' ), $module_slug ) );
    509. 

  509. 			}
    510. 

  510. 			if ( 'toggle' === $action ) {
    511. 

  511. 				$action = Jetpack::is_module_active( $module_slug )
    512. 

  512. 					? 'deactivate'
    513. 

  513. 					: 'activate';
    514. 

  514. 			}
    515. 

  515. 			if ( 'all' === $args[1] ) {
    516. 

  516. 				$action = ( 'deactivate' === $action )
    517. 

  517. 					? 'deactivate_all'
    518. 

  518. 					: 'activate_all';
    519. 

  519. 			}
    520. 

  520. 		} elseif ( 'list' !== $action ) {
    521. 

  521. 			WP_CLI::line( __( 'Please specify a valid module.', 'jetpack' ) );
    522. 

  522. 			$action = 'list';
    523. 

  523. 		}
    524. 

  524. 

  525. 		switch ( $action ) {
    526. 

  526. 			case 'list':
    527. 

  527. 				$modules_list = array();
    528. 

  528. 				$modules      = Jetpack::get_available_modules();
    529. 

  529. 				sort( $modules );
    530. 

  530. 				foreach ( (array) $modules as $module_slug ) {
    531. 

  531. 					if ( 'vaultpress' === $module_slug ) {
    532. 

  532. 						continue;
    533. 

  533. 					}
    534. 

  534. 					$modules_list[] = array(
    535. 

  535. 						'slug'   => $module_slug,
    536. 

  536. 						'status' => Jetpack::is_module_active( $module_slug )
    537. 

  537. 							? __( 'Active', 'jetpack' )
    538. 

  538. 							: __( 'Inactive', 'jetpack' ),
    539. 

  539. 					);
    540. 

  540. 				}
    541. 

  541. 				WP_CLI\Utils\format_items( $assoc_args['format'], $modules_list, array( 'slug', 'status' ) );
    542. 

  542. 				break;
    543. 

  543. 			case 'activate':
    544. 

  544. 				$module = Jetpack::get_module( $module_slug );
    545. 

  545. 				Jetpack::log( 'activate', $module_slug );
    546. 

  546. 				if ( Jetpack::activate_module( $module_slug, false, false ) ) {
    547. 

  547. 					/* translators: %s is the name of a Jetpack module */
    548. 

  548. 					WP_CLI::success( sprintf( __( '%s has been activated.', 'jetpack' ), $module['name'] ) );
    549. 

  549. 				} else {
    550. 

  550. 					/* translators: %s is the name of a Jetpack module */
    551. 

  551. 					WP_CLI::error( sprintf( __( '%s could not be activated.', 'jetpack' ), $module['name'] ) );
    552. 

  552. 				}
    553. 

  553. 				break;
    554. 

  554. 			case 'activate_all':
    555. 

  555. 				$modules = Jetpack::get_available_modules();
    556. 

  556. 				Jetpack::update_active_modules( $modules );
    557. 

  557. 				WP_CLI::success( __( 'All modules activated!', 'jetpack' ) );
    558. 

  558. 				break;
    559. 

  559. 			case 'deactivate':
    560. 

  560. 				$module = Jetpack::get_module( $module_slug );
    561. 

  561. 				Jetpack::log( 'deactivate', $module_slug );
    562. 

  562. 				Jetpack::deactivate_module( $module_slug );
    563. 

  563. 				/* translators: %s is the name of a Jetpack module */
    564. 

  564. 				WP_CLI::success( sprintf( __( '%s has been deactivated.', 'jetpack' ), $module['name'] ) );
    565. 

  565. 				break;
    566. 

  566. 			case 'deactivate_all':
    567. 

  567. 				Jetpack::delete_active_modules();
    568. 

  568. 				WP_CLI::success( __( 'All modules deactivated!', 'jetpack' ) );
    569. 

  569. 				break;
    570. 

  570. 			case 'toggle':
    571. 

  571. 				// Will never happen, should have been handled above and changed to activate or deactivate.
    572. 

  572. 				break;
    573. 

  573. 		}
    574. 

  574. 	}
    575. 

  575. 

  576. 	/**
    577. 

  577. 	 * Manage Protect Settings
    578. 

  578. 	 *
    579. 

  579. 	 * ## OPTIONS
    580. 

  580. 	 *
    581. 

  581. 	 * allow: Add an IP address to an always allow list.  You can also read or clear the allow list.
    582. 

  582. 	 *
    583. 

  583. 	 *
    584. 

  584. 	 * ## EXAMPLES
    585. 

  585. 	 *
    586. 

  586. 	 * wp jetpack protect allow <ip address>
    587. 

  587. 	 * wp jetpack protect allow list
    588. 

  588. 	 * wp jetpack protect allow clear
    589. 

  589. 	 *
    590. 

  590. 	 * @synopsis <allow> [<ip|ip_low-ip_high|list|clear>]
    591. 

  591. 	 */
    592. 

  592. 	public function protect( $args, $assoc_args ) {
    593. 

  593. 		$action = isset( $args[0] ) ? $args[0] : 'prompt';
    594. 

  594. 		if ( ! in_array( $action, array( 'whitelist', 'allow' ), true ) ) { // Still allow "whitelist" for legacy support.
    595. 

  595. 			/* translators: %s is a command like "prompt" */
    596. 

  596. 			WP_CLI::error( sprintf( __( '%s is not a valid command.', 'jetpack' ), $action ) );
    597. 

  597. 		}
    598. 

  598. 		// Check if module is active
    599. 

  599. 		if ( ! Jetpack::is_module_active( __FUNCTION__ ) ) {
    600. 

  600. 			/* translators: %s is a module name */
    601. 

  601. 			WP_CLI::error( sprintf( _x( '%1$s is not active. You can activate it with "wp jetpack module activate %2$s"', '"wp jetpack module activate" is a command - do not translate', 'jetpack' ), __FUNCTION__, __FUNCTION__ ) );
    602. 

  602. 		}
    603. 

  603. 		if ( in_array( $action, array( 'allow', 'whitelist' ), true ) ) {
    604. 

  604. 			if ( isset( $args[1] ) ) {
    605. 

  605. 				$action = 'allow';
    606. 

  606. 			} else {
    607. 

  607. 				$action = 'prompt';
    608. 

  608. 			}
    609. 

  609. 		}
    610. 

  610. 		switch ( $action ) {
    611. 

  611. 			case 'allow':
    612. 

  612. 				$allow         = array();
    613. 

  613. 				$new_ip        = $args[1];
    614. 

  614. 				$current_allow = get_site_option( 'jetpack_protect_whitelist', array() ); // @todo Update the option name.
    615. 

  615. 

  616. 				// Build array of IPs that are already on the allowed list.
    617. 

  617. 				// Re-build manually instead of using jetpack_protect_format_whitelist() so we can easily get
    618. 

  618. 				// low & high range params for jetpack_protect_ip_address_is_in_range();
    619. 

  619. 				foreach ( $current_allow as $allowed ) {
    620. 

  620. 

  621. 					// IP ranges
    622. 

  622. 					if ( $allowed->range ) {
    623. 

  623. 

  624. 						// Is it already on the allowed list?
    625. 

  625. 						if ( jetpack_protect_ip_address_is_in_range( $new_ip, $allowed->range_low, $allowed->range_high ) ) {
    626. 

  626. 							/* translators: %s is an IP address */
    627. 

  627. 							WP_CLI::error( sprintf( __( '%s is already on the always allow list.', 'jetpack' ), $new_ip ) );
    628. 

  628. 							break;
    629. 

  629. 						}
    630. 

  630. 						$allow[] = $allowed->range_low . ' - ' . $allowed->range_high;
    631. 

  631. 

  632. 					} else { // Individual IPs
    633. 

  633. 

  634. 						// Check if the IP is already on the allow list (single IP only).
    635. 

  635. 						if ( $new_ip === $allowed->ip_address ) {
    636. 

  636. 							/* translators: %s is an IP address */
    637. 

  637. 							WP_CLI::error( sprintf( __( '%s is already on the always allow list.', 'jetpack' ), $new_ip ) );
    638. 

  638. 							break;
    639. 

  639. 						}
    640. 

  640. 						$allow[] = $allowed->ip_address;
    641. 

  641. 

  642. 					}
    643. 

  643. 				}
    644. 

  644. 

  645. 				/*
    646. 

  646. 				 * List the allowed IPs.
    647. 

  647. 				 * Done here because it's easier to read the $allow array after it's been rebuilt.
    648. 

  648. 				 */
    649. 

  649. 				if ( isset( $args[1] ) && 'list' == $args[1] ) {
    650. 

  650. 					if ( ! empty( $allow ) ) {
    651. 

  651. 						WP_CLI::success( __( 'Here are your always allowed IPs:', 'jetpack' ) );
    652. 

  652. 						foreach ( $allow as $ip ) {
    653. 

  653. 							WP_CLI::line( "\t" . str_pad( $ip, 24 ) );
    654. 

  654. 						}
    655. 

  655. 					} else {
    656. 

  656. 						WP_CLI::line( __( 'Always allow list is empty.', 'jetpack' ) );
    657. 

  657. 					}
    658. 

  658. 					break;
    659. 

  659. 				}
    660. 

  660. 

  661. 				/*
    662. 

  662. 				 * Clear the always allow list.
    663. 

  663. 				 */
    664. 

  664. 				if ( isset( $args[1] ) && 'clear' == $args[1] ) {
    665. 

  665. 					if ( ! empty( $allow ) ) {
    666. 

  666. 						$allow = array();
    667. 

  667. 						jetpack_protect_save_whitelist( $allow ); // @todo Need to update function name in the Protect module.
    668. 

  668. 						WP_CLI::success( __( 'Cleared all IPs from the always allow list.', 'jetpack' ) );
    669. 

  669. 					} else {
    670. 

  670. 						WP_CLI::line( __( 'Always allow list is empty.', 'jetpack' ) );
    671. 

  671. 					}
    672. 

  672. 					break;
    673. 

  673. 				}
    674. 

  674. 

  675. 				// Append new IP to allow array.
    676. 

  676. 				array_push( $allow, $new_ip );
    677. 

  677. 

  678. 				// Save allow list if there are no errors.
    679. 

  679. 				$result = jetpack_protect_save_whitelist( $allow ); // @todo Need to update function name in the Protect module.
    680. 

  680. 				if ( is_wp_error( $result ) ) {
    681. 

  681. 					WP_CLI::error( $result );
    682. 

  682. 				}
    683. 

  683. 

  684. 				/* translators: %s is an IP address */
    685. 

  685. 				WP_CLI::success( sprintf( __( '%s has been added to the always allowed list.', 'jetpack' ), $new_ip ) );
    686. 

  686. 				break;
    687. 

  687. 			case 'prompt':
    688. 

  688. 				WP_CLI::error(
    689. 

  689. 					__( 'No command found.', 'jetpack' ) . "\n" .
    690. 

  690. 					__( 'Please enter the IP address you want to always allow.', 'jetpack' ) . "\n" .
    691. 

  691. 					_x( 'You can save a range of IPs {low_range}-{high_range}. No spaces allowed. (example: 1.1.1.1-2.2.2.2)', 'Instructions on how to add IP ranges - low_range/high_range should be translated.', 'jetpack' ) . "\n" .
    692. 

  692. 					_x( "You can also 'list' or 'clear' the always allowed list.", "'list' and 'clear' are commands and should not be translated", 'jetpack' ) . "\n"
    693. 

  693. 				);
    694. 

  694. 				break;
    695. 

  695. 		}
    696. 

  696. 	}
    697. 

  697. 

  698. 	/**
    699. 

  699. 	 * Manage Jetpack Options
    700. 

  700. 	 *
    701. 

  701. 	 * ## OPTIONS
    702. 

  702. 	 *
    703. 

  703. 	 * list   : List all jetpack options and their values
    704. 

  704. 	 * delete : Delete an option
    705. 

  705. 	 *          - can only delete options that are white listed.
    706. 

  706. 	 * update : update an option
    707. 

  707. 	 *          - can only update option strings
    708. 

  708. 	 * get    : get the value of an option
    709. 

  709. 	 *
    710. 

  710. 	 * ## EXAMPLES
    711. 

  711. 	 *
    712. 

  712. 	 * wp jetpack options list
    713. 

  713. 	 * wp jetpack options get    <option_name>
    714. 

  714. 	 * wp jetpack options delete <option_name>
    715. 

  715. 	 * wp jetpack options update <option_name> [<option_value>]
    716. 

  716. 	 *
    717. 

  717. 	 * @synopsis <list|get|delete|update> [<option_name>] [<option_value>]
    718. 

  718. 	 */
    719. 

  719. 	public function options( $args, $assoc_args ) {
    720. 

  720. 		$action         = isset( $args[0] ) ? $args[0] : 'list';
    721. 

  721. 		$safe_to_modify = Jetpack_Options::get_options_for_reset();
    722. 

  722. 

  723. 		// Is the option flagged as unsafe?
    724. 

  724. 		$flagged = ! in_array( $args[1], $safe_to_modify );
    725. 

  725. 

  726. 		if ( ! in_array( $action, array( 'list', 'get', 'delete', 'update' ) ) ) {
    727. 

  727. 			/* translators: %s is a command like "prompt" */
    728. 

  728. 			WP_CLI::error( sprintf( __( '%s is not a valid command.', 'jetpack' ), $action ) );
    729. 

  729. 		}
    730. 

  730. 

  731. 		if ( isset( $args[0] ) ) {
    732. 

  732. 			if ( 'get' == $args[0] && isset( $args[1] ) ) {
    733. 

  733. 				$action = 'get';
    734. 

  734. 			} elseif ( 'delete' == $args[0] && isset( $args[1] ) ) {
    735. 

  735. 				$action = 'delete';
    736. 

  736. 			} elseif ( 'update' == $args[0] && isset( $args[1] ) ) {
    737. 

  737. 				$action = 'update';
    738. 

  738. 			} else {
    739. 

  739. 				$action = 'list';
    740. 

  740. 			}
    741. 

  741. 		}
    742. 

  742. 

  743. 		// Bail if the option isn't found
    744. 

  744. 		$option = isset( $args[1] ) ? Jetpack_Options::get_option( $args[1] ) : false;
    745. 

  745. 		if ( isset( $args[1] ) && ! $option && 'update' !== $args[0] ) {
    746. 

  746. 			WP_CLI::error( __( 'Option not found or is empty. Use "list" to list option names', 'jetpack' ) );
    747. 

  747. 		}
    748. 

  748. 

  749. 		// Let's print_r the option if it's an array
    750. 

  750. 		// Used in the 'get' and 'list' actions
    751. 

  751. 		$option = is_array( $option ) ? print_r( $option ) : $option;
    752. 

  752. 

  753. 		switch ( $action ) {
    754. 

  754. 			case 'get':
    755. 

  755. 				WP_CLI::success( "\t" . $option );
    756. 

  756. 				break;
    757. 

  757. 			case 'delete':
    758. 

  758. 				jetpack_cli_are_you_sure( $flagged );
    759. 

  759. 

  760. 				Jetpack_Options::delete_option( $args[1] );
    761. 

  761. 				/* translators: %s is the option name */
    762. 

  762. 				WP_CLI::success( sprintf( __( 'Deleted option: %s', 'jetpack' ), $args[1] ) );
    763. 

  763. 				break;
    764. 

  764. 			case 'update':
    765. 

  765. 				jetpack_cli_are_you_sure( $flagged );
    766. 

  766. 

  767. 				// Updating arrays would get pretty tricky...
    768. 

  768. 				$value = Jetpack_Options::get_option( $args[1] );
    769. 

  769. 				if ( $value && is_array( $value ) ) {
    770. 

  770. 					WP_CLI::error( __( 'Sorry, no updating arrays at this time', 'jetpack' ) );
    771. 

  771. 				}
    772. 

  772. 

  773. 				Jetpack_Options::update_option( $args[1], $args[2] );
    774. 

  774. 				/* translators: %1$s is the previous value, %2$s is the new value */
    775. 

  775. 				WP_CLI::success( sprintf( _x( 'Updated option: %1$s to "%2$s"', 'Updating an option from "this" to "that".', 'jetpack' ), $args[1], $args[2] ) );
    776. 

  776. 				break;
    777. 

  777. 			case 'list':
    778. 

  778. 				$options_compact     = Jetpack_Options::get_option_names();
    779. 

  779. 				$options_non_compact = Jetpack_Options::get_option_names( 'non_compact' );
    780. 

  780. 				$options_private     = Jetpack_Options::get_option_names( 'private' );
    781. 

  781. 				$options             = array_merge( $options_compact, $options_non_compact, $options_private );
    782. 

  782. 

  783. 				// Table headers
    784. 

  784. 				WP_CLI::line( "\t" . str_pad( __( 'Option', 'jetpack' ), 30 ) . __( 'Value', 'jetpack' ) );
    785. 

  785. 

  786. 				// List out the options and their values
    787. 

  787. 				// Tell them if the value is empty or not
    788. 

  788. 				// Tell them if it's an array
    789. 

  789. 				foreach ( $options as $option ) {
    790. 

  790. 					$value = Jetpack_Options::get_option( $option );
    791. 

  791. 					if ( ! $value ) {
    792. 

  792. 						WP_CLI::line( "\t" . str_pad( $option, 30 ) . 'Empty' );
    793. 

  793. 						continue;
    794. 

  794. 					}
    795. 

  795. 

  796. 					if ( ! is_array( $value ) ) {
    797. 

  797. 						WP_CLI::line( "\t" . str_pad( $option, 30 ) . $value );
    798. 

  798. 					} elseif ( is_array( $value ) ) {
    799. 

  799. 						WP_CLI::line( "\t" . str_pad( $option, 30 ) . 'Array - Use "get <option>" to read option array.' );
    800. 

  800. 					}
    801. 

  801. 				}
    802. 

  802. 				$option_text = '{' . _x( 'option', 'a variable command that a user can write, provided in the printed instructions', 'jetpack' ) . '}';
    803. 

  803. 				$value_text  = '{' . _x( 'value', 'the value that they want to update the option to', 'jetpack' ) . '}';
    804. 

  804. 

  805. 				WP_CLI::success(
    806. 

  806. 					_x( "Above are your options. You may 'get', 'delete', and 'update' them.", "'get', 'delete', and 'update' are commands - do not translate.", 'jetpack' ) . "\n" .
    807. 

  807. 					str_pad( 'wp jetpack options get', 26 ) . $option_text . "\n" .
    808. 

  808. 					str_pad( 'wp jetpack options delete', 26 ) . $option_text . "\n" .
    809. 

  809. 					str_pad( 'wp jetpack options update', 26 ) . "$option_text $value_text" . "\n" .
    810. 

  810. 					_x( "Type 'wp jetpack options' for more info.", "'wp jetpack options' is a command - do not translate.", 'jetpack' ) . "\n"
    811. 

  811. 				);
    812. 

  812. 				break;
    813. 

  813. 		}
    814. 

  814. 	}
    815. 

  815. 

  816. 	/**
    817. 

  817. 	 * Get the status of or start a new Jetpack sync.
    818. 

  818. 	 *
    819. 

  819. 	 * ## OPTIONS
    820. 

  820. 	 *
    821. 

  821. 	 * status   : Print the current sync status
    822. 

  822. 	 * settings : Prints the current sync settings
    823. 

  823. 	 * start    : Start a full sync from this site to WordPress.com
    824. 

  824. 	 * enable   : Enables sync on the site
    825. 

  825. 	 * disable  : Disable sync on a site
    826. 

  826. 	 * reset    : Disables sync and Resets the sync queues on a site
    827. 

  827. 	 *
    828. 

  828. 	 * ## EXAMPLES
    829. 

  829. 	 *
    830. 

  830. 	 * wp jetpack sync status
    831. 

  831. 	 * wp jetpack sync settings
    832. 

  832. 	 * wp jetpack sync start --modules=functions --sync_wait_time=5
    833. 

  833. 	 * wp jetpack sync enable
    834. 

  834. 	 * wp jetpack sync disable
    835. 

  835. 	 * wp jetpack sync reset
    836. 

  836. 	 * wp jetpack sync reset --queue=full or regular
    837. 

  837. 	 *
    838. 

  838. 	 * @synopsis <status|start> [--<field>=<value>]
    839. 

  839. 	 */
    840. 

  840. 	public function sync( $args, $assoc_args ) {
    841. 

  841. 

  842. 		$action = isset( $args[0] ) ? $args[0] : 'status';
    843. 

  843. 

  844. 		switch ( $action ) {
    845. 

  845. 			case 'status':
    846. 

  846. 				$status     = Actions::get_sync_status();
    847. 

  847. 				$collection = array();
    848. 

  848. 				foreach ( $status as $key => $item ) {
    849. 

  849. 					$collection[] = array(
    850. 

  850. 						'option' => $key,
    851. 

  851. 						'value'  => is_scalar( $item ) ? $item : json_encode( $item ),
    852. 

  852. 					);
    853. 

  853. 				}
    854. 

  854. 				WP_CLI::log( __( 'Sync Status:', 'jetpack' ) );
    855. 

  855. 				WP_CLI\Utils\format_items( 'table', $collection, array( 'option', 'value' ) );
    856. 

  856. 				break;
    857. 

  857. 			case 'settings':
    858. 

  858. 				WP_CLI::log( __( 'Sync Settings:', 'jetpack' ) );
    859. 

  859. 				foreach ( Settings::get_settings() as $setting => $item ) {
    860. 

  860. 					$settings[] = array(
    861. 

  861. 						'setting' => $setting,
    862. 

  862. 						'value'   => is_scalar( $item ) ? $item : json_encode( $item ),
    863. 

  863. 					);
    864. 

  864. 				}
    865. 

  865. 				WP_CLI\Utils\format_items( 'table', $settings, array( 'setting', 'value' ) );
    866. 

  866. 

  867. 			case 'disable':
    868. 

  868. 				// Don't set it via the Settings since that also resets the queues.
    869. 

  869. 				update_option( 'jetpack_sync_settings_disable', 1 );
    870. 

  870. 				/* translators: %s is the site URL */
    871. 

  871. 				WP_CLI::log( sprintf( __( 'Sync Disabled on %s', 'jetpack' ), get_site_url() ) );
    872. 

  872. 				break;
    873. 

  873. 			case 'enable':
    874. 

  874. 				Settings::update_settings( array( 'disable' => 0 ) );
    875. 

  875. 				/* translators: %s is the site URL */
    876. 

  876. 				WP_CLI::log( sprintf( __( 'Sync Enabled on %s', 'jetpack' ), get_site_url() ) );
    877. 

  877. 				break;
    878. 

  878. 			case 'reset':
    879. 

  879. 				// Don't set it via the Settings since that also resets the queues.
    880. 

  880. 				update_option( 'jetpack_sync_settings_disable', 1 );
    881. 

  881. 

  882. 				/* translators: %s is the site URL */
    883. 

  883. 				WP_CLI::log( sprintf( __( 'Sync Disabled on %s. Use `wp jetpack sync enable` to enable syncing again.', 'jetpack' ), get_site_url() ) );
    884. 

  884. 				$listener = Listener::get_instance();
    885. 

  885. 				if ( empty( $assoc_args['queue'] ) ) {
    886. 

  886. 					$listener->get_sync_queue()->reset();
    887. 

  887. 					$listener->get_full_sync_queue()->reset();
    888. 

  888. 					/* translators: %s is the site URL */
    889. 

  889. 					WP_CLI::log( sprintf( __( 'Reset Full Sync and Regular Queues Queue on %s', 'jetpack' ), get_site_url() ) );
    890. 

  890. 					break;
    891. 

  891. 				}
    892. 

  892. 

  893. 				if ( ! empty( $assoc_args['queue'] ) ) {
    894. 

  894. 					switch ( $assoc_args['queue'] ) {
    895. 

  895. 						case 'regular':
    896. 

  896. 							$listener->get_sync_queue()->reset();
    897. 

  897. 							/* translators: %s is the site URL */
    898. 

  898. 							WP_CLI::log( sprintf( __( 'Reset Regular Sync Queue on %s', 'jetpack' ), get_site_url() ) );
    899. 

  899. 							break;
    900. 

  900. 						case 'full':
    901. 

  901. 							$listener->get_full_sync_queue()->reset();
    902. 

  902. 							/* translators: %s is the site URL */
    903. 

  903. 							WP_CLI::log( sprintf( __( 'Reset Full Sync Queue on %s', 'jetpack' ), get_site_url() ) );
    904. 

  904. 							break;
    905. 

  905. 						default:
    906. 

  906. 							WP_CLI::error( __( 'Please specify what type of queue do you want to reset: `full` or `regular`.', 'jetpack' ) );
    907. 

  907. 							break;
    908. 

  908. 					}
    909. 

  909. 				}
    910. 

  910. 

  911. 				break;
    912. 

  912. 			case 'start':
    913. 

  913. 				if ( ! Actions::sync_allowed() ) {
    914. 

  914. 					if ( Settings::get_setting( 'disable' ) ) {
    915. 

  915. 						WP_CLI::error( __( 'Jetpack sync is not currently allowed for this site. It is currently disabled. Run `wp jetpack sync enable` to enable it.', 'jetpack' ) );
    916. 

  916. 						return;
    917. 

  917. 					}
    918. 

  918. 					$connection = new Connection_Manager();
    919. 

  919. 					if ( ! $connection->is_connected() ) {
    920. 

  920. 						if ( ! doing_action( 'jetpack_site_registered' ) ) {
    921. 

  921. 							WP_CLI::error( __( 'Jetpack sync is not currently allowed for this site. Jetpack is not connected.', 'jetpack' ) );
    922. 

  922. 							return;
    923. 

  923. 						}
    924. 

  924. 					}
    925. 

  925. 

  926. 					$status = new Status();
    927. 

  927. 

  928. 					if ( $status->is_offline_mode() ) {
    929. 

  929. 						WP_CLI::error( __( 'Jetpack sync is not currently allowed for this site. The site is in offline mode.', 'jetpack' ) );
    930. 

  930. 						return;
    931. 

  931. 					}
    932. 

  932. 					if ( $status->is_staging_site() ) {
    933. 

  933. 						WP_CLI::error( __( 'Jetpack sync is not currently allowed for this site. The site is in staging mode.', 'jetpack' ) );
    934. 

  934. 						return;
    935. 

  935. 					}
    936. 

  936. 				}
    937. 

  937. 				// Get the original settings so that we can restore them later
    938. 

  938. 				$original_settings = Settings::get_settings();
    939. 

  939. 

  940. 				// Initialize sync settigns so we can sync as quickly as possible
    941. 

  941. 				$sync_settings = wp_parse_args(
    942. 

  942. 					array_intersect_key( $assoc_args, Settings::$valid_settings ),
    943. 

  943. 					array(
    944. 

  944. 						'sync_wait_time'           => 0,
    945. 

  945. 						'enqueue_wait_time'        => 0,
    946. 

  946. 						'queue_max_writes_sec'     => 10000,
    947. 

  947. 						'max_queue_size_full_sync' => 100000,
    948. 

  948. 						'full_sync_send_duration'  => HOUR_IN_SECONDS,
    949. 

  949. 					)
    950. 

  950. 				);
    951. 

  951. 				Settings::update_settings( $sync_settings );
    952. 

  952. 

  953. 				// Convert comma-delimited string of modules to an array
    954. 

  954. 				if ( ! empty( $assoc_args['modules'] ) ) {
    955. 

  955. 					$modules = array_map( 'trim', explode( ',', $assoc_args['modules'] ) );
    956. 

  956. 

  957. 					// Convert the array so that the keys are the module name and the value is true to indicate
    958. 

  958. 					// that we want to sync the module
    959. 

  959. 					$modules = array_map( '__return_true', array_flip( $modules ) );
    960. 

  960. 				}
    961. 

  961. 

  962. 				foreach ( array( 'posts', 'comments', 'users' ) as $module_name ) {
    963. 

  963. 					if (
    964. 

  964. 						'users' === $module_name &&
    965. 

  965. 						isset( $assoc_args[ $module_name ] ) &&
    966. 

  966. 						'initial' === $assoc_args[ $module_name ]
    967. 

  967. 					) {
    968. 

  968. 						$modules['users'] = 'initial';
    969. 

  969. 					} elseif ( isset( $assoc_args[ $module_name ] ) ) {
    970. 

  970. 						$ids = explode( ',', $assoc_args[ $module_name ] );
    971. 

  971. 						if ( count( $ids ) > 0 ) {
    972. 

  972. 							$modules[ $module_name ] = $ids;
    973. 

  973. 						}
    974. 

  974. 					}
    975. 

  975. 				}
    976. 

  976. 

  977. 				if ( empty( $modules ) ) {
    978. 

  978. 					$modules = null;
    979. 

  979. 				}
    980. 

  980. 

  981. 				// Kick off a full sync
    982. 

  982. 				if ( Actions::do_full_sync( $modules ) ) {
    983. 

  983. 					if ( $modules ) {
    984. 

  984. 						/* translators: %s is a comma separated list of Jetpack modules */
    985. 

  985. 						WP_CLI::log( sprintf( __( 'Initialized a new full sync with modules: %s', 'jetpack' ), join( ', ', array_keys( $modules ) ) ) );
    986. 

  986. 					} else {
    987. 

  987. 						WP_CLI::log( __( 'Initialized a new full sync', 'jetpack' ) );
    988. 

  988. 					}
    989. 

  989. 				} else {
    990. 

  990. 

  991. 					// Reset sync settings to original.
    992. 

  992. 					Settings::update_settings( $original_settings );
    993. 

  993. 

  994. 					if ( $modules ) {
    995. 

  995. 						/* translators: %s is a comma separated list of Jetpack modules */
    996. 

  996. 						WP_CLI::error( sprintf( __( 'Could not start a new full sync with modules: %s', 'jetpack' ), join( ', ', $modules ) ) );
    997. 

  997. 					} else {
    998. 

  998. 						WP_CLI::error( __( 'Could not start a new full sync', 'jetpack' ) );
    999. 

  999. 					}
    1000. 

  1000. 				}
    1001. 

  1001. 

  1002. 				// Keep sending to WPCOM until there's nothing to send
    1003. 

  1003. 				$i = 1;
    1004. 

  1004. 				do {
    1005. 

  1005. 					$result = Actions::$sender->do_full_sync();
    1006. 

  1006. 					if ( is_wp_error( $result ) ) {
    1007. 

  1007. 						$queue_empty_error = ( 'empty_queue_full_sync' == $result->get_error_code() );
    1008. 

  1008. 						if ( ! $queue_empty_error || ( $queue_empty_error && ( 1 == $i ) ) ) {
    1009. 

  1009. 							/* translators: %s is an error code  */
    1010. 

  1010. 							WP_CLI::error( sprintf( __( 'Sync errored with code: %s', 'jetpack' ), $result->get_error_code() ) );
    1011. 

  1011. 						}
    1012. 

  1012. 					} else {
    1013. 

  1013. 						if ( 1 == $i ) {
    1014. 

  1014. 							WP_CLI::log( __( 'Sent data to WordPress.com', 'jetpack' ) );
    1015. 

  1015. 						} else {
    1016. 

  1016. 							WP_CLI::log( __( 'Sent more data to WordPress.com', 'jetpack' ) );
    1017. 

  1017. 						}
    1018. 

  1018. 

  1019. 						// Immediate Full Sync does not wait for WP.com to process data so we need to enforce a wait.
    1020. 

  1020. 						if ( false !== strpos( get_class( Modules::get_module( 'full-sync' ) ), 'Full_Sync_Immediately' ) ) {
    1021. 

  1021. 							sleep( 15 );
    1022. 

  1022. 						}
    1023. 

  1023. 					}
    1024. 

  1024. 					$i++;
    1025. 

  1025. 				} while ( $result && ! is_wp_error( $result ) );
    1026. 

  1026. 

  1027. 				// Reset sync settings to original.
    1028. 

  1028. 				Settings::update_settings( $original_settings );
    1029. 

  1029. 

  1030. 				WP_CLI::success( __( 'Finished syncing to WordPress.com', 'jetpack' ) );
    1031. 

  1031. 				break;
    1032. 

  1032. 		}
    1033. 

  1033. 	}
    1034. 

  1034. 

  1035. 	/**
    1036. 

  1036. 	 * List the contents of a specific Jetpack sync queue.
    1037. 

  1037. 	 *
    1038. 

  1038. 	 * ## OPTIONS
    1039. 

  1039. 	 *
    1040. 

  1040. 	 * peek : List the 100 front-most items on the queue.
    1041. 

  1041. 	 *
    1042. 

  1042. 	 * ## EXAMPLES
    1043. 

  1043. 	 *
    1044. 

  1044. 	 * wp jetpack sync_queue full_sync peek
    1045. 

  1045. 	 *
    1046. 

  1046. 	 * @synopsis <incremental|full_sync> <peek>
    1047. 

  1047. 	 */
    1048. 

  1048. 	public function sync_queue( $args, $assoc_args ) {
    1049. 

  1049. 		if ( ! Actions::sync_allowed() ) {
    1050. 

  1050. 			WP_CLI::error( __( 'Jetpack sync is not currently allowed for this site.', 'jetpack' ) );
    1051. 

  1051. 		}
    1052. 

  1052. 

  1053. 		$queue_name = isset( $args[0] ) ? $args[0] : 'sync';
    1054. 

  1054. 		$action     = isset( $args[1] ) ? $args[1] : 'peek';
    1055. 

  1055. 

  1056. 		// We map the queue name that way we can support more friendly queue names in the commands, but still use
    1057. 

  1057. 		// the queue name that the code expects.
    1058. 

  1058. 		$queue_name_map    = $allowed_queues = array(
    1059. 

  1059. 			'incremental' => 'sync',
    1060. 

  1060. 			'full'        => 'full_sync',
    1061. 

  1061. 		);
    1062. 

  1062. 		$mapped_queue_name = isset( $queue_name_map[ $queue_name ] ) ? $queue_name_map[ $queue_name ] : $queue_name;
    1063. 

  1063. 

  1064. 		switch ( $action ) {
    1065. 

  1065. 			case 'peek':
    1066. 

  1066. 				$queue = new Queue( $mapped_queue_name );
    1067. 

  1067. 				$items = $queue->peek( 100 );
    1068. 

  1068. 

  1069. 				if ( empty( $items ) ) {
    1070. 

  1070. 					/* translators: %s is the name of the queue, either 'incremental' or 'full' */
    1071. 

  1071. 					WP_CLI::log( sprintf( __( 'Nothing is in the queue: %s', 'jetpack' ), $queue_name ) );
    1072. 

  1072. 				} else {
    1073. 

  1073. 					$collection = array();
    1074. 

  1074. 					foreach ( $items as $item ) {
    1075. 

  1075. 						$collection[] = array(
    1076. 

  1076. 							'action'          => $item[0],
    1077. 

  1077. 							'args'            => json_encode( $item[1] ),
    1078. 

  1078. 							'current_user_id' => $item[2],
    1079. 

  1079. 							'microtime'       => $item[3],
    1080. 

  1080. 							'importing'       => (string) $item[4],
    1081. 

  1081. 						);
    1082. 

  1082. 					}
    1083. 

  1083. 					WP_CLI\Utils\format_items(
    1084. 

  1084. 						'table',
    1085. 

  1085. 						$collection,
    1086. 

  1086. 						array(
    1087. 

  1087. 							'action',
    1088. 

  1088. 							'args',
    1089. 

  1089. 							'current_user_id',
    1090. 

  1090. 							'microtime',
    1091. 

  1091. 							'importing',
    1092. 

  1092. 						)
    1093. 

  1093. 					);
    1094. 

  1094. 				}
    1095. 

  1095. 				break;
    1096. 

  1096. 		}
    1097. 

  1097. 	}
    1098. 

  1098. 

  1099. 	/**
    1100. 

  1100. 	 * Cancel's the current Jetpack plan granted by this partner, if applicable
    1101. 

  1101. 	 *
    1102. 

  1102. 	 * Returns success or error JSON
    1103. 

  1103. 	 *
    1104. 

  1104. 	 * <token_json>
    1105. 

  1105. 	 * : JSON blob of WPCOM API token
    1106. 

  1106. 	 *  [--partner_tracking_id=<partner_tracking_id>]
    1107. 

  1107. 	 * : This is an optional ID that a host can pass to help identify a site in logs on WordPress.com
    1108. 

  1108. 	 *
    1109. 

  1109. 	 *  * @synopsis <token_json> [--partner_tracking_id=<partner_tracking_id>]
    1110. 

  1110. 	 */
    1111. 

  1111. 	public function partner_cancel( $args, $named_args ) {
    1112. 

  1112. 		list( $token_json ) = $args;
    1113. 

  1113. 

  1114. 		if ( ! $token_json || ! ( $token = json_decode( $token_json ) ) ) {
    1115. 

  1115. 			/* translators: %s is the invalid JSON string */
    1116. 

  1116. 			$this->partner_provision_error( new WP_Error( 'missing_access_token', sprintf( __( 'Invalid token JSON: %s', 'jetpack' ), $token_json ) ) );
    1117. 

  1117. 		}
    1118. 

  1118. 

  1119. 		if ( isset( $token->error ) ) {
    1120. 

  1120. 			$this->partner_provision_error( new WP_Error( $token->error, $token->message ) );
    1121. 

  1121. 		}
    1122. 

  1122. 

  1123. 		if ( ! isset( $token->access_token ) ) {
    1124. 

  1124. 			$this->partner_provision_error( new WP_Error( 'missing_access_token', __( 'Missing or invalid access token', 'jetpack' ) ) );
    1125. 

  1125. 		}
    1126. 

  1126. 

  1127. 		if ( Identity_Crisis::validate_sync_error_idc_option() ) {
    1128. 

  1128. 			$this->partner_provision_error(
    1129. 

  1129. 				new WP_Error(
    1130. 

  1130. 					'site_in_safe_mode',
    1131. 

  1131. 					esc_html__( 'Can not cancel a plan while in safe mode. See: https://jetpack.com/support/safe-mode/', 'jetpack' )
    1132. 

  1132. 				)
    1133. 

  1133. 			);
    1134. 

  1134. 		}
    1135. 

  1135. 

  1136. 		$site_identifier = Jetpack_Options::get_option( 'id' );
    1137. 

  1137. 

  1138. 		if ( ! $site_identifier ) {
    1139. 

  1139. 			$status          = new Status();
    1140. 

  1140. 			$site_identifier = $status->get_site_suffix();
    1141. 

  1141. 		}
    1142. 

  1142. 

  1143. 		$request = array(
    1144. 

  1144. 			'headers' => array(
    1145. 

  1145. 				'Authorization' => 'Bearer ' . $token->access_token,
    1146. 

  1146. 				'Host'          => 'public-api.wordpress.com',
    1147. 

  1147. 			),
    1148. 

  1148. 			'timeout' => 60,
    1149. 

  1149. 			'method'  => 'POST',
    1150. 

  1150. 		);
    1151. 

  1151. 

  1152. 		$url = sprintf( '%s/rest/v1.3/jpphp/%s/partner-cancel', $this->get_api_host(), $site_identifier );
    1153. 

  1153. 		if ( ! empty( $named_args ) && ! empty( $named_args['partner_tracking_id'] ) ) {
    1154. 

  1154. 			$url = esc_url_raw( add_query_arg( 'partner_tracking_id', $named_args['partner_tracking_id'], $url ) );
    1155. 

  1155. 		}
    1156. 

  1156. 

  1157. 		$result = Client::_wp_remote_request( $url, $request );
    1158. 

  1158. 

  1159. 		Jetpack_Options::delete_option( 'onboarding' );
    1160. 

  1160. 

  1161. 		if ( is_wp_error( $result ) ) {
    1162. 

  1162. 			$this->partner_provision_error( $result );
    1163. 

  1163. 		}
    1164. 

  1164. 

  1165. 		WP_CLI::log( wp_remote_retrieve_body( $result ) );
    1166. 

  1166. 	}
    1167. 

  1167. 

  1168. 	/**
    1169. 

  1169. 	 * Provision a site using a Jetpack Partner license
    1170. 

  1170. 	 *
    1171. 

  1171. 	 * Returns JSON blob
    1172. 

  1172. 	 *
    1173. 

  1173. 	 * ## OPTIONS
    1174. 

  1174. 	 *
    1175. 

  1175. 	 * <token_json>
    1176. 

  1176. 	 * : JSON blob of WPCOM API token
    1177. 

  1177. 	 * [--plan=<plan_name>]
    1178. 

  1178. 	 * : Slug of the requested plan, e.g. premium
    1179. 

  1179. 	 * [--wpcom_user_id=<user_id>]
    1180. 

  1180. 	 * : WordPress.com ID of user to connect as (must be whitelisted against partner key)
    1181. 

  1181. 	 * [--wpcom_user_email=<wpcom_user_email>]
    1182. 

  1182. 	 * : Override the email we send to WordPress.com for registration
    1183. 

  1183. 	 * [--onboarding=<onboarding>]
    1184. 

  1184. 	 * : Guide the user through an onboarding wizard
    1185. 

  1185. 	 * [--force_register=<register>]
    1186. 

  1186. 	 * : Whether to force a site to register
    1187. 

  1187. 	 * [--force_connect=<force_connect>]
    1188. 

  1188. 	 * : Force JPS to not reuse existing credentials
    1189. 

  1189. 	 * [--home_url=<home_url>]
    1190. 

  1190. 	 * : Overrides the home option via the home_url filter, or the WP_HOME constant
    1191. 

  1191. 	 * [--site_url=<site_url>]
    1192. 

  1192. 	 * : Overrides the siteurl option via the site_url filter, or the WP_SITEURL constant
    1193. 

  1193. 	 * [--partner_tracking_id=<partner_tracking_id>]
    1194. 

  1194. 	 * : This is an optional ID that a host can pass to help identify a site in logs on WordPress.com
    1195. 

  1195. 	 *
    1196. 

  1196. 	 * ## EXAMPLES
    1197. 

  1197. 	 *
    1198. 

  1198. 	 *     $ wp jetpack partner_provision '{ some: "json" }' premium 1
    1199. 

  1199. 	 *     { success: true }
    1200. 

  1200. 	 *
    1201. 

  1201. 	 * @synopsis <token_json> [--wpcom_user_id=<user_id>] [--plan=<plan_name>] [--onboarding=<onboarding>] [--force_register=<register>] [--force_connect=<force_connect>] [--home_url=<home_url>] [--site_url=<site_url>] [--wpcom_user_email=<wpcom_user_email>] [--partner_tracking_id=<partner_tracking_id>]
    1202. 

  1202. 	 */
    1203. 

  1203. 	public function partner_provision( $args, $named_args ) {
    1204. 

  1204. 		list( $token_json ) = $args;
    1205. 

  1205. 

  1206. 		if ( ! $token_json || ! ( $token = json_decode( $token_json ) ) ) {
    1207. 

  1207. 			/* translators: %s is the invalid JSON string */
    1208. 

  1208. 			$this->partner_provision_error( new WP_Error( 'missing_access_token', sprintf( __( 'Invalid token JSON: %s', 'jetpack' ), $token_json ) ) );
    1209. 

  1209. 		}
    1210. 

  1210. 

  1211. 		if ( isset( $token->error ) ) {
    1212. 

  1212. 			$message = isset( $token->message )
    1213. 

  1213. 				? $token->message
    1214. 

  1214. 				: '';
    1215. 

  1215. 			$this->partner_provision_error( new WP_Error( $token->error, $message ) );
    1216. 

  1216. 		}
    1217. 

  1217. 

  1218. 		if ( ! isset( $token->access_token ) ) {
    1219. 

  1219. 			$this->partner_provision_error( new WP_Error( 'missing_access_token', __( 'Missing or invalid access token', 'jetpack' ) ) );
    1220. 

  1220. 		}
    1221. 

  1221. 

  1222. 		require_once JETPACK__PLUGIN_DIR . '_inc/class.jetpack-provision.php';
    1223. 

  1223. 

  1224. 		$body_json = Jetpack_Provision::partner_provision( $token->access_token, $named_args );
    1225. 

  1225. 

  1226. 		if ( is_wp_error( $body_json ) ) {
    1227. 

  1227. 			error_log(
    1228. 

  1228. 				json_encode(
    1229. 

  1229. 					array(
    1230. 

  1230. 						'success'       => false,
    1231. 

  1231. 						'error_code'    => $body_json->get_error_code(),
    1232. 

  1232. 						'error_message' => $body_json->get_error_message(),
    1233. 

  1233. 					)
    1234. 

  1234. 				)
    1235. 

  1235. 			);
    1236. 

  1236. 			exit( 1 );
    1237. 

  1237. 		}
    1238. 

  1238. 

  1239. 		WP_CLI::log( json_encode( $body_json ) );
    1240. 

  1240. 	}
    1241. 

  1241. 

  1242. 	/**
    1243. 

  1243. 	 * Manages your Jetpack sitemap
    1244. 

  1244. 	 *
    1245. 

  1245. 	 * ## OPTIONS
    1246. 

  1246. 	 *
    1247. 

  1247. 	 * rebuild : Rebuild all sitemaps
    1248. 

  1248. 	 * --purge : if set, will remove all existing sitemap data before rebuilding
    1249. 

  1249. 	 *
    1250. 

  1250. 	 * ## EXAMPLES
    1251. 

  1251. 	 *
    1252. 

  1252. 	 * wp jetpack sitemap rebuild
    1253. 

  1253. 	 *
    1254. 

  1254. 	 * @subcommand sitemap
    1255. 

  1255. 	 * @synopsis <rebuild> [--purge]
    1256. 

  1256. 	 */
    1257. 

  1257. 	public function sitemap( $args, $assoc_args ) {
    1258. 

  1258. 		if ( ! Jetpack::is_connection_ready() ) {
    1259. 

  1259. 			WP_CLI::error( __( 'Jetpack is not currently connected to WordPress.com', 'jetpack' ) );
    1260. 

  1260. 		}
    1261. 

  1261. 		if ( ! Jetpack::is_module_active( 'sitemaps' ) ) {
    1262. 

  1262. 			WP_CLI::error( __( 'Jetpack Sitemaps module is not currently active. Activate it first if you want to work with sitemaps.', 'jetpack' ) );
    1263. 

  1263. 		}
    1264. 

  1264. 		if ( ! class_exists( 'Jetpack_Sitemap_Builder' ) ) {
    1265. 

  1265. 			WP_CLI::error( __( 'Jetpack Sitemaps module is active, but unavailable. This can happen if your site is set to discourage search engine indexing. Please enable search engine indexing to allow sitemap generation.', 'jetpack' ) );
    1266. 

  1266. 		}
    1267. 

  1267. 

  1268. 		if ( isset( $assoc_args['purge'] ) && $assoc_args['purge'] ) {
    1269. 

  1269. 			$librarian = new Jetpack_Sitemap_Librarian();
    1270. 

  1270. 			$librarian->delete_all_stored_sitemap_data();
    1271. 

  1271. 		}
    1272. 

  1272. 

  1273. 		$sitemap_builder = new Jetpack_Sitemap_Builder();
    1274. 

  1274. 		$sitemap_builder->update_sitemap();
    1275. 

  1275. 	}
    1276. 

  1276. 

  1277. 	/**
    1278. 

  1278. 	 * Allows authorizing a user via the command line and will activate
    1279. 

  1279. 	 *
    1280. 

  1280. 	 * ## EXAMPLES
    1281. 

  1281. 	 *
    1282. 

  1282. 	 * wp jetpack authorize_user --token=123456789abcdef
    1283. 

  1283. 	 *
    1284. 

  1284. 	 * @synopsis --token=<value>
    1285. 

  1285. 	 */
    1286. 

  1286. 	public function authorize_user( $args, $named_args ) {
    1287. 

  1287. 		if ( ! is_user_logged_in() ) {
    1288. 

  1288. 			WP_CLI::error( __( 'Please select a user to authorize via the --user global argument.', 'jetpack' ) );
    1289. 

  1289. 		}
    1290. 

  1290. 

  1291. 		if ( empty( $named_args['token'] ) ) {
    1292. 

  1292. 			WP_CLI::error( __( 'A non-empty token argument must be passed.', 'jetpack' ) );
    1293. 

  1293. 		}
    1294. 

  1294. 

  1295. 		$is_connection_owner = ! Jetpack::connection()->has_connected_owner();
    1296. 

  1296. 		$current_user_id     = get_current_user_id();
    1297. 

  1297. 

  1298. 		( new Tokens() )->update_user_token( $current_user_id, sprintf( '%s.%d', $named_args['token'], $current_user_id ), $is_connection_owner );
    1299. 

  1299. 

  1300. 		WP_CLI::log( wp_json_encode( $named_args ) );
    1301. 

  1301. 

  1302. 		if ( $is_connection_owner ) {
    1303. 

  1303. 			/**
    1304. 

  1304. 			 * Auto-enable SSO module for new Jetpack Start connections
    1305. 

  1305. 			*
    1306. 

  1306. 			* @since 5.0.0
    1307. 

  1307. 			*
    1308. 

  1308. 			* @param bool $enable_sso Whether to enable the SSO module. Default to true.
    1309. 

  1309. 			*/
    1310. 

  1310. 			$enable_sso = apply_filters( 'jetpack_start_enable_sso', true );
    1311. 

  1311. 			Jetpack::handle_post_authorization_actions( $enable_sso, false );
    1312. 

  1312. 

  1313. 			/* translators: %d is a user ID */
    1314. 

  1314. 			WP_CLI::success( sprintf( __( 'Authorized %d and activated default modules.', 'jetpack' ), $current_user_id ) );
    1315. 

  1315. 		} else {
    1316. 

  1316. 			/* translators: %d is a user ID */
    1317. 

  1317. 			WP_CLI::success( sprintf( __( 'Authorized %d.', 'jetpack' ), $current_user_id ) );
    1318. 

  1318. 		}
    1319. 

  1319. 	}
    1320. 

  1320. 

  1321. 	/**
    1322. 

  1322. 	 * Allows calling a WordPress.com API endpoint using the current blog's token.
    1323. 

  1323. 	 *
    1324. 

  1324. 	 * ## OPTIONS
    1325. 

  1325. 	 * --resource=<resource>
    1326. 

  1326. 	 * : The resource to call with the current blog's token, where `%d` represents the current blog's ID.
    1327. 

  1327. 	 *
    1328. 

  1328. 	 * [--api_version=<api_version>]
    1329. 

  1329. 	 * : The API version to query against.
    1330. 

  1330. 	 *
    1331. 

  1331. 	 * [--base_api_path=<base_api_path>]
    1332. 

  1332. 	 * : The base API path to query.
    1333. 

  1333. 	 * ---
    1334. 

  1334. 	 * default: rest
    1335. 

  1335. 	 * ---
    1336. 

  1336. 	 *
    1337. 

  1337. 	 * [--body=<body>]
    1338. 

  1338. 	 * : A JSON encoded string representing arguments to send in the body.
    1339. 

  1339. 	 *
    1340. 

  1340. 	 * [--field=<value>]
    1341. 

  1341. 	 * : Any number of arguments that should be passed to the resource.
    1342. 

  1342. 	 *
    1343. 

  1343. 	 * [--pretty]
    1344. 

  1344. 	 * : Will pretty print the results of a successful API call.
    1345. 

  1345. 	 *
    1346. 

  1346. 	 * [--strip-success]
    1347. 

  1347. 	 * : Will remove the green success label from successful API calls.
    1348. 

  1348. 	 *
    1349. 

  1349. 	 * ## EXAMPLES
    1350. 

  1350. 	 *
    1351. 

  1351. 	 * wp jetpack call_api --resource='/sites/%d'
    1352. 

  1352. 	 */
    1353. 

  1353. 	public function call_api( $args, $named_args ) {
    1354. 

  1354. 		if ( ! Jetpack::is_connection_ready() ) {
    1355. 

  1355. 			WP_CLI::error( __( 'Jetpack is not currently connected to WordPress.com', 'jetpack' ) );
    1356. 

  1356. 		}
    1357. 

  1357. 

  1358. 		$consumed_args = array(
    1359. 

  1359. 			'resource',
    1360. 

  1360. 			'api_version',
    1361. 

  1361. 			'base_api_path',
    1362. 

  1362. 			'body',
    1363. 

  1363. 			'pretty',
    1364. 

  1364. 		);
    1365. 

  1365. 

  1366. 		// Get args that should be passed to resource.
    1367. 

  1367. 		$other_args = array_diff_key( $named_args, array_flip( $consumed_args ) );
    1368. 

  1368. 

  1369. 		$decoded_body = ! empty( $named_args['body'] )
    1370. 

  1370. 			? json_decode( $named_args['body'], true )
    1371. 

  1371. 			: false;
    1372. 

  1372. 

  1373. 		$resource_url = ( false === strpos( $named_args['resource'], '%d' ) )
    1374. 

  1374. 			? $named_args['resource']
    1375. 

  1375. 			: sprintf( $named_args['resource'], Jetpack_Options::get_option( 'id' ) );
    1376. 

  1376. 

  1377. 		$response = Client::wpcom_json_api_request_as_blog(
    1378. 

  1378. 			$resource_url,
    1379. 

  1379. 			empty( $named_args['api_version'] ) ? Client::WPCOM_JSON_API_VERSION : $named_args['api_version'],
    1380. 

  1380. 			$other_args,
    1381. 

  1381. 			empty( $decoded_body ) ? null : $decoded_body,
    1382. 

  1382. 			empty( $named_args['base_api_path'] ) ? 'rest' : $named_args['base_api_path']
    1383. 

  1383. 		);
    1384. 

  1384. 

  1385. 		if ( is_wp_error( $response ) ) {
    1386. 

  1386. 			WP_CLI::error(
    1387. 

  1387. 				sprintf(
    1388. 

  1388. 					/* translators: %1$s is an endpoint route (ex. /sites/123456), %2$d is an error code, %3$s is an error message. */
    1389. 

  1389. 					__( 'Request to %1$s returned an error: (%2$d) %3$s.', 'jetpack' ),
    1390. 

  1390. 					$resource_url,
    1391. 

  1391. 					$response->get_error_code(),
    1392. 

  1392. 					$response->get_error_message()
    1393. 

  1393. 				)
    1394. 

  1394. 			);
    1395. 

  1395. 		}
    1396. 

  1396. 

  1397. 		if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
    1398. 

  1398. 			WP_CLI::error(
    1399. 

  1399. 				sprintf(
    1400. 

  1400. 					/* translators: %1$s is an endpoint route (ex. /sites/123456), %2$d is an HTTP status code. */
    1401. 

  1401. 					__( 'Request to %1$s returned a non-200 response code: %2$d.', 'jetpack' ),
    1402. 

  1402. 					$resource_url,
    1403. 

  1403. 					wp_remote_retrieve_response_code( $response )
    1404. 

  1404. 				)
    1405. 

  1405. 			);
    1406. 

  1406. 		}
    1407. 

  1407. 

  1408. 		$output = wp_remote_retrieve_body( $response );
    1409. 

  1409. 		if ( isset( $named_args['pretty'] ) ) {
    1410. 

  1410. 			$decoded_output = json_decode( $output );
    1411. 

  1411. 			if ( $decoded_output ) {
    1412. 

  1412. 				$output = wp_json_encode( $decoded_output, JSON_PRETTY_PRINT );
    1413. 

  1413. 			}
    1414. 

  1414. 		}
    1415. 

  1415. 

  1416. 		if ( isset( $named_args['strip-success'] ) ) {
    1417. 

  1417. 			WP_CLI::log( $output );
    1418. 

  1418. 			WP_CLI::halt( 0 );
    1419. 

  1419. 		}
    1420. 

  1420. 

  1421. 		WP_CLI::success( $output );
    1422. 

  1422. 	}
    1423. 

  1423. 

  1424. 	/**
    1425. 

  1425. 	 * Allows uploading SSH Credentials to the current site for backups, restores, and security scanning.
    1426. 

  1426. 	 *
    1427. 

  1427. 	 * ## OPTIONS
    1428. 

  1428. 	 *
    1429. 

  1429. 	 * [--host=<host>]
    1430. 

  1430. 	 * : The SSH server's address.
    1431. 

  1431. 	 *
    1432. 

  1432. 	 * [--ssh-user=<user>]
    1433. 

  1433. 	 * : The username to use to log in to the SSH server.
    1434. 

  1434. 	 *
    1435. 

  1435. 	 * [--pass=<pass>]
    1436. 

  1436. 	 * : The password used to log in, if using a password. (optional)
    1437. 

  1437. 	 *
    1438. 

  1438. 	 * [--kpri=<kpri>]
    1439. 

  1439. 	 * : The private key used to log in, if using a private key. (optional)
    1440. 

  1440. 	 *
    1441. 

  1441. 	 * [--pretty]
    1442. 

  1442. 	 * : Will pretty print the results of a successful API call. (optional)
    1443. 

  1443. 	 *
    1444. 

  1444. 	 * [--strip-success]
    1445. 

  1445. 	 * : Will remove the green success label from successful API calls. (optional)
    1446. 

  1446. 	 *
    1447. 

  1447. 	 * ## EXAMPLES
    1448. 

  1448. 	 *
    1449. 

  1449. 	 * wp jetpack upload_ssh_creds --host=example.com --ssh-user=example --pass=password
    1450. 

  1450. 	 * wp jetpack updload_ssh_creds --host=example.com --ssh-user=example --kpri=key
    1451. 

  1451. 	 */
    1452. 

  1452. 	public function upload_ssh_creds( $args, $named_args ) {
    1453. 

  1453. 		if ( ! Jetpack::is_connection_ready() ) {
    1454. 

  1454. 			WP_CLI::error( __( 'Jetpack is not currently connected to WordPress.com', 'jetpack' ) );
    1455. 

  1455. 		}
    1456. 

  1456. 

  1457. 		$required_args = array(
    1458. 

  1458. 			'host',
    1459. 

  1459. 			'ssh-user',
    1460. 

  1460. 		);
    1461. 

  1461. 

  1462. 		foreach ( $required_args as $arg ) {
    1463. 

  1463. 			if ( empty( $named_args[ $arg ] ) ) {
    1464. 

  1464. 				WP_CLI::error(
    1465. 

  1465. 					sprintf(
    1466. 

  1466. 						/* translators: %s is a slug, such as 'host'. */
    1467. 

  1467. 						__( '`%s` cannot be empty.', 'jetpack' ),
    1468. 

  1468. 						$arg
    1469. 

  1469. 					)
    1470. 

  1470. 				);
    1471. 

  1471. 			}
    1472. 

  1472. 		}
    1473. 

  1473. 

  1474. 		if ( empty( $named_args['pass'] ) && empty( $named_args['kpri'] ) ) {
    1475. 

  1475. 			WP_CLI::error( __( 'Both `pass` and `kpri` fields cannot be blank.', 'jetpack' ) );
    1476. 

  1476. 		}
    1477. 

  1477. 

  1478. 		$values = array(
    1479. 

  1479. 			'credentials' => array(
    1480. 

  1480. 				'site_url' => get_site_url(),
    1481. 

  1481. 				'abspath'  => ABSPATH,
    1482. 

  1482. 				'protocol' => 'ssh',
    1483. 

  1483. 				'port'     => 22,
    1484. 

  1484. 				'role'     => 'main',
    1485. 

  1485. 				'host'     => $named_args['host'],
    1486. 

  1486. 				'user'     => $named_args['ssh-user'],
    1487. 

  1487. 				'pass'     => empty( $named_args['pass'] ) ? '' : $named_args['pass'],
    1488. 

  1488. 				'kpri'     => empty( $named_args['kpri'] ) ? '' : $named_args['kpri'],
    1489. 

  1489. 			),
    1490. 

  1490. 		);
    1491. 

  1491. 

  1492. 		$named_args = wp_parse_args(
    1493. 

  1493. 			array(
    1494. 

  1494. 				'resource'    => '/activity-log/%d/update-credentials',
    1495. 

  1495. 				'method'      => 'POST',
    1496. 

  1496. 				'api_version' => '1.1',
    1497. 

  1497. 				'body'        => wp_json_encode( $values ),
    1498. 

  1498. 				'timeout'     => 30,
    1499. 

  1499. 			),
    1500. 

  1500. 			$named_args
    1501. 

  1501. 		);
    1502. 

  1502. 

  1503. 		self::call_api( $args, $named_args );
    1504. 

  1504. 	}
    1505. 

  1505. 

  1506. 	/**
    1507. 

  1507. 	 * API wrapper for getting stats from the WordPress.com API for the current site.
    1508. 

  1508. 	 *
    1509. 

  1509. 	 * ## OPTIONS
    1510. 

  1510. 	 *
    1511. 

  1511. 	 * [--quantity=<quantity>]
    1512. 

  1512. 	 * : The number of units to include.
    1513. 

  1513. 	 * ---
    1514. 

  1514. 	 * default: 30
    1515. 

  1515. 	 * ---
    1516. 

  1516. 	 *
    1517. 

  1517. 	 * [--period=<period>]
    1518. 

  1518. 	 * : The unit of time to query stats for.
    1519. 

  1519. 	 * ---
    1520. 

  1520. 	 * default: day
    1521. 

  1521. 	 * options:
    1522. 

  1522. 	 *  - day
    1523. 

  1523. 	 *  - week
    1524. 

  1524. 	 *  - month
    1525. 

  1525. 	 *  - year
    1526. 

  1526. 	 * ---
    1527. 

  1527. 	 *
    1528. 

  1528. 	 * [--date=<date>]
    1529. 

  1529. 	 * : The latest date to return stats for. Ex. - 2018-01-01.
    1530. 

  1530. 	 *
    1531. 

  1531. 	 * [--pretty]
    1532. 

  1532. 	 * : Will pretty print the results of a successful API call.
    1533. 

  1533. 	 *
    1534. 

  1534. 	 * [--strip-success]
    1535. 

  1535. 	 * : Will remove the green success label from successful API calls.
    1536. 

  1536. 	 *
    1537. 

  1537. 	 * ## EXAMPLES
    1538. 

  1538. 	 *
    1539. 

  1539. 	 * wp jetpack get_stats
    1540. 

  1540. 	 */
    1541. 

  1541. 	public function get_stats( $args, $named_args ) {
    1542. 

  1542. 		$selected_args = array_intersect_key(
    1543. 

  1543. 			$named_args,
    1544. 

  1544. 			array_flip(
    1545. 

  1545. 				array(
    1546. 

  1546. 					'quantity',
    1547. 

  1547. 					'date',
    1548. 

  1548. 				)
    1549. 

  1549. 			)
    1550. 

  1550. 		);
    1551. 

  1551. 

  1552. 		// The API expects unit, but period seems to be more correct.
    1553. 

  1553. 		$selected_args['unit'] = $named_args['period'];
    1554. 

  1554. 

  1555. 		$command = sprintf(
    1556. 

  1556. 			'jetpack call_api --resource=/sites/%d/stats/%s',
    1557. 

  1557. 			Jetpack_Options::get_option( 'id' ),
    1558. 

  1558. 			add_query_arg( $selected_args, 'visits' )
    1559. 

  1559. 		);
    1560. 

  1560. 

  1561. 		if ( isset( $named_args['pretty'] ) ) {
    1562. 

  1562. 			$command .= ' --pretty';
    1563. 

  1563. 		}
    1564. 

  1564. 

  1565. 		if ( isset( $named_args['strip-success'] ) ) {
    1566. 

  1566. 			$command .= ' --strip-success';
    1567. 

  1567. 		}
    1568. 

  1568. 

  1569. 		WP_CLI::runcommand(
    1570. 

  1570. 			$command,
    1571. 

  1571. 			array(
    1572. 

  1572. 				'launch' => false, // Use the current process.
    1573. 

  1573. 			)
    1574. 

  1574. 		);
    1575. 

  1575. 	}
    1576. 

  1576. 

  1577. 	/**
    1578. 

  1578. 	 * Allows management of publicize connections.
    1579. 

  1579. 	 *
    1580. 

  1580. 	 * ## OPTIONS
    1581. 

  1581. 	 *
    1582. 

  1582. 	 * <list|disconnect>
    1583. 

  1583. 	 * : The action to perform.
    1584. 

  1584. 	 * ---
    1585. 

  1585. 	 * options:
    1586. 

  1586. 	 *   - list
    1587. 

  1587. 	 *   - disconnect
    1588. 

  1588. 	 * ---
    1589. 

  1589. 	 *
    1590. 

  1590. 	 * [<identifier>]
    1591. 

  1591. 	 * : The connection ID or service to perform an action on.
    1592. 

  1592. 	 *
    1593. 

  1593. 	 * [--format=<format>]
    1594. 

  1594. 	 * : Allows overriding the output of the command when listing connections.
    1595. 

  1595. 	 * ---
    1596. 

  1596. 	 * default: table
    1597. 

  1597. 	 * options:
    1598. 

  1598. 	 *   - table
    1599. 

  1599. 	 *   - json
    1600. 

  1600. 	 *   - csv
    1601. 

  1601. 	 *   - yaml
    1602. 

  1602. 	 *   - ids
    1603. 

  1603. 	 *   - count
    1604. 

  1604. 	 * ---
    1605. 

  1605. 	 *
    1606. 

  1606. 	 * ## EXAMPLES
    1607. 

  1607. 	 *
    1608. 

  1608. 	 *     # List all publicize connections.
    1609. 

  1609. 	 *     $ wp jetpack publicize list
    1610. 

  1610. 	 *
    1611. 

  1611. 	 *     # List publicize connections for a given service.
    1612. 

  1612. 	 *     $ wp jetpack publicize list twitter
    1613. 

  1613. 	 *
    1614. 

  1614. 	 *     # List all publicize connections for a given user.
    1615. 

  1615. 	 *     $ wp --user=1 jetpack publicize list
    1616. 

  1616. 	 *
    1617. 

  1617. 	 *     # List all publicize connections for a given user and service.
    1618. 

  1618. 	 *     $ wp --user=1 jetpack publicize list twitter
    1619. 

  1619. 	 *
    1620. 

  1620. 	 *     # Display details for a given connection.
    1621. 

  1621. 	 *     $ wp jetpack publicize list 123456
    1622. 

  1622. 	 *
    1623. 

  1623. 	 *     # Diconnection a given connection.
    1624. 

  1624. 	 *     $ wp jetpack publicize disconnect 123456
    1625. 

  1625. 	 *
    1626. 

  1626. 	 *     # Disconnect all connections.
    1627. 

  1627. 	 *     $ wp jetpack publicize disconnect all
    1628. 

  1628. 	 *
    1629. 

  1629. 	 *     # Disconnect all connections for a given service.
    1630. 

  1630. 	 *     $ wp jetpack publicize disconnect twitter
    1631. 

  1631. 	 */
    1632. 

  1632. 	public function publicize( $args, $named_args ) {
    1633. 

  1633. 		if ( ! Jetpack::connection()->has_connected_owner() ) {
    1634. 

  1634. 			WP_CLI::error( __( 'Publicize requires a user-level connection to WordPress.com', 'jetpack' ) );
    1635. 

  1635. 		}
    1636. 

  1636. 

  1637. 		if ( ! Jetpack::is_module_active( 'publicize' ) ) {
    1638. 

  1638. 			WP_CLI::error( __( 'The publicize module is not active.', 'jetpack' ) );
    1639. 

  1639. 		}
    1640. 

  1640. 

  1641. 		if ( ( new Status() )->is_offline_mode() ) {
    1642. 

  1642. 			if (
    1643. 

  1643. 				! defined( 'JETPACK_DEV_DEBUG' ) &&
    1644. 

  1644. 				! has_filter( 'jetpack_development_mode' ) &&
    1645. 

  1645. 				! has_filter( 'jetpack_offline_mode' ) &&
    1646. 

  1646. 				false === strpos( site_url(), '.' )
    1647. 

  1647. 			) {
    1648. 

  1648. 				WP_CLI::error( __( "Jetpack is current in offline mode because the site url does not contain a '.', which often occurs when dynamically setting the WP_SITEURL constant. While in offline mode, the publicize module will not load.", 'jetpack' ) );
    1649. 

  1649. 			}
    1650. 

  1650. 

  1651. 			WP_CLI::error( __( 'Jetpack is currently in offline mode, so the publicize module will not load.', 'jetpack' ) );
    1652. 

  1652. 		}
    1653. 

  1653. 

  1654. 		if ( ! class_exists( 'Publicize' ) ) {
    1655. 

  1655. 			WP_CLI::error( __( 'The publicize module is not loaded.', 'jetpack' ) );
    1656. 

  1656. 		}
    1657. 

  1657. 

  1658. 		$action        = $args[0];
    1659. 

  1659. 		$publicize     = new Publicize();
    1660. 

  1660. 		$identifier    = ! empty( $args[1] ) ? $args[1] : false;
    1661. 

  1661. 		$services      = array_keys( $publicize->get_services() );
    1662. 

  1662. 		$id_is_service = in_array( $identifier, $services, true );
    1663. 

  1663. 

  1664. 		switch ( $action ) {
    1665. 

  1665. 			case 'list':
    1666. 

  1666. 				$connections_to_return = array();
    1667. 

  1667. 

  1668. 				// For the CLI command, let's return all connections when a user isn't specified. This
    1669. 

  1669. 				// differs from the logic in the Publicize class.
    1670. 

  1670. 				$option_connections = is_user_logged_in()
    1671. 

  1671. 					? (array) $publicize->get_all_connections_for_user()
    1672. 

  1672. 					: (array) $publicize->get_all_connections();
    1673. 

  1673. 

  1674. 				foreach ( $option_connections as $service_name => $connections ) {
    1675. 

  1675. 					foreach ( (array) $connections as $id => $connection ) {
    1676. 

  1676. 						$connection['id']        = $id;
    1677. 

  1677. 						$connection['service']   = $service_name;
    1678. 

  1678. 						$connections_to_return[] = $connection;
    1679. 

  1679. 					}
    1680. 

  1680. 				}
    1681. 

  1681. 

  1682. 				if ( $id_is_service && ! empty( $identifier ) && ! empty( $connections_to_return ) ) {
    1683. 

  1683. 					$temp_connections      = $connections_to_return;
    1684. 

  1684. 					$connections_to_return = array();
    1685. 

  1685. 

  1686. 					foreach ( $temp_connections as $connection ) {
    1687. 

  1687. 						if ( $identifier === $connection['service'] ) {
    1688. 

  1688. 							$connections_to_return[] = $connection;
    1689. 

  1689. 						}
    1690. 

  1690. 					}
    1691. 

  1691. 				}
    1692. 

  1692. 

  1693. 				if ( $identifier && ! $id_is_service && ! empty( $connections_to_return ) ) {
    1694. 

  1694. 					$connections_to_return = wp_list_filter( $connections_to_return, array( 'id' => $identifier ) );
    1695. 

  1695. 				}
    1696. 

  1696. 

  1697. 				$expected_keys = array(
    1698. 

  1698. 					'id',
    1699. 

  1699. 					'service',
    1700. 

  1700. 					'user_id',
    1701. 

  1701. 					'provider',
    1702. 

  1702. 					'issued',
    1703. 

  1703. 					'expires',
    1704. 

  1704. 					'external_id',
    1705. 

  1705. 					'external_name',
    1706. 

  1706. 					'external_display',
    1707. 

  1707. 					'type',
    1708. 

  1708. 					'connection_data',
    1709. 

  1709. 				);
    1710. 

  1710. 

  1711. 				// Somehow, a test site ended up in a state where $connections_to_return looked like:
    1712. 

  1712. 				// array( array( array( 'id' => 0, 'service' => 0 ) ) ) // phpcs:ignore Squiz.PHP.CommentedOutCode.Found
    1713. 

  1713. 				// This caused the CLI command to error when running WP_CLI\Utils\format_items() below. So
    1714. 

  1714. 				// to minimize future issues, this nested loop will remove any connections that don't contain
    1715. 

  1715. 				// any keys that we expect.
    1716. 

  1716. 				foreach ( (array) $connections_to_return as $connection_key => $connection ) {
    1717. 

  1717. 					foreach ( $expected_keys as $expected_key ) {
    1718. 

  1718. 						if ( ! isset( $connection[ $expected_key ] ) ) {
    1719. 

  1719. 							unset( $connections_to_return[ $connection_key ] );
    1720. 

  1720. 							continue;
    1721. 

  1721. 						}
    1722. 

  1722. 					}
    1723. 

  1723. 				}
    1724. 

  1724. 

  1725. 				if ( empty( $connections_to_return ) ) {
    1726. 

  1726. 					return false;
    1727. 

  1727. 				}
    1728. 

  1728. 

  1729. 				WP_CLI\Utils\format_items( $named_args['format'], $connections_to_return, $expected_keys );
    1730. 

  1730. 				break; // list.
    1731. 

  1731. 			case 'disconnect':
    1732. 

  1732. 				if ( ! $identifier ) {
    1733. 

  1733. 					WP_CLI::error( __( 'A connection ID must be passed in order to disconnect.', 'jetpack' ) );
    1734. 

  1734. 				}
    1735. 

  1735. 

  1736. 				// If the connection ID is 'all' then delete all connections. If the connection ID
    1737. 

  1737. 				// matches a service, delete all connections for that service.
    1738. 

  1738. 				if ( 'all' === $identifier || $id_is_service ) {
    1739. 

  1739. 					if ( 'all' === $identifier ) {
    1740. 

  1740. 						WP_CLI::log( __( "You're about to delete all publicize connections.", 'jetpack' ) );
    1741. 

  1741. 					} else {
    1742. 

  1742. 						/* translators: %s is a lowercase string for a social network. */
    1743. 

  1743. 						WP_CLI::log( sprintf( __( "You're about to delete all publicize connections to %s.", 'jetpack' ), $identifier ) );
    1744. 

  1744. 					}
    1745. 

  1745. 

  1746. 					jetpack_cli_are_you_sure();
    1747. 

  1747. 

  1748. 					$connections = array();
    1749. 

  1749. 					$service     = $identifier;
    1750. 

  1750. 

  1751. 					$option_connections = is_user_logged_in()
    1752. 

  1752. 						? (array) $publicize->get_all_connections_for_user()
    1753. 

  1753. 						: (array) $publicize->get_all_connections();
    1754. 

  1754. 

  1755. 					if ( 'all' === $service ) {
    1756. 

  1756. 						foreach ( (array) $option_connections as $service_name => $service_connections ) {
    1757. 

  1757. 							foreach ( $service_connections as $id => $connection ) {
    1758. 

  1758. 								$connections[ $id ] = $connection;
    1759. 

  1759. 							}
    1760. 

  1760. 						}
    1761. 

  1761. 					} elseif ( ! empty( $option_connections[ $service ] ) ) {
    1762. 

  1762. 						$connections = $option_connections[ $service ];
    1763. 

  1763. 					}
    1764. 

  1764. 

  1765. 					if ( ! empty( $connections ) ) {
    1766. 

  1766. 						$count    = count( $connections );
    1767. 

  1767. 						$progress = \WP_CLI\Utils\make_progress_bar(
    1768. 

  1768. 							/* translators: %s is a lowercase string for a social network. */
    1769. 

  1769. 							sprintf( __( 'Disconnecting all connections to %s.', 'jetpack' ), $service ),
    1770. 

  1770. 							$count
    1771. 

  1771. 						);
    1772. 

  1772. 

  1773. 						foreach ( $connections as $id => $connection ) {
    1774. 

  1774. 							if ( false === $publicize->disconnect( false, $id ) ) {
    1775. 

  1775. 								WP_CLI::error(
    1776. 

  1776. 									sprintf(
    1777. 

  1777. 										/* translators: %1$d is a numeric ID and %2$s is a lowercase string for a social network. */
    1778. 

  1778. 										__( 'Publicize connection %d could not be disconnected', 'jetpack' ),
    1779. 

  1779. 										$id
    1780. 

  1780. 									)
    1781. 

  1781. 								);
    1782. 

  1782. 							}
    1783. 

  1783. 

  1784. 							$progress->tick();
    1785. 

  1785. 						}
    1786. 

  1786. 

  1787. 						$progress->finish();
    1788. 

  1788. 

  1789. 						if ( 'all' === $service ) {
    1790. 

  1790. 							WP_CLI::success( __( 'All publicize connections were successfully disconnected.', 'jetpack' ) );
    1791. 

  1791. 						} else {
    1792. 

  1792. 							/* translators: %s is a lowercase string for a social network. */
    1793. 

  1793. 							WP_CLI::success( __( 'All publicize connections to %s were successfully disconnected.', 'jetpack' ), $service );
    1794. 

  1794. 						}
    1795. 

  1795. 					}
    1796. 

  1796. 				} else {
    1797. 

  1797. 					if ( false !== $publicize->disconnect( false, $identifier ) ) {
    1798. 

  1798. 						/* translators: %d is a numeric ID. Example: 1234. */
    1799. 

  1799. 						WP_CLI::success( sprintf( __( 'Publicize connection %d has been disconnected.', 'jetpack' ), $identifier ) );
    1800. 

  1800. 					} else {
    1801. 

  1801. 						/* translators: %d is a numeric ID. Example: 1234. */
    1802. 

  1802. 						WP_CLI::error( sprintf( __( 'Publicize connection %d could not be disconnected.', 'jetpack' ), $identifier ) );
    1803. 

  1803. 					}
    1804. 

  1804. 				}
    1805. 

  1805. 				break; // disconnect.
    1806. 

  1806. 		}
    1807. 

  1807. 	}
    1808. 

  1808. 

  1809. 	private function get_api_host() {
    1810. 

  1810. 		$env_api_host = getenv( 'JETPACK_START_API_HOST', true );
    1811. 

  1811. 		return $env_api_host ? 'https://' . $env_api_host : JETPACK__WPCOM_JSON_API_BASE;
    1812. 

  1812. 	}
    1813. 

  1813. 

  1814. 	private function partner_provision_error( $error ) {
    1815. 

  1815. 		WP_CLI::log(
    1816. 

  1816. 			json_encode(
    1817. 

  1817. 				array(
    1818. 

  1818. 					'success'       => false,
    1819. 

  1819. 					'error_code'    => $error->get_error_code(),
    1820. 

  1820. 					'error_message' => $error->get_error_message(),
    1821. 

  1821. 				)
    1822. 

  1822. 			)
    1823. 

  1823. 		);
    1824. 

  1824. 		exit( 1 );
    1825. 

  1825. 	}
    1826. 

  1826. 

  1827. 	/**
    1828. 

  1828. 	 * Creates the essential files in Jetpack to start building a Gutenberg block or plugin.
    1829. 

  1829. 	 *
    1830. 

  1830. 	 * ## TYPES
    1831. 

  1831. 	 *
    1832. 

  1832. 	 * block: it creates a Jetpack block. All files will be created in a directory under extensions/blocks named based on the block title or a specific given slug.
    1833. 

  1833. 	 *
    1834. 

  1834. 	 * ## BLOCK TYPE OPTIONS
    1835. 

  1835. 	 *
    1836. 

  1836. 	 * The first parameter is the block title and it's not associative. Add it wrapped in quotes.
    1837. 

  1837. 	 * The title is also used to create the slug and the edit PHP class name. If it's something like "Logo gallery", the slug will be 'logo-gallery' and the class name will be LogoGalleryEdit.
    1838. 

  1838. 	 * --slug: Specific slug to identify the block that overrides the one generated based on the title.
    1839. 

  1839. 	 * --description: Allows to provide a text description of the block.
    1840. 

  1840. 	 * --keywords: Provide up to three keywords separated by comma so users can find this block when they search in Gutenberg's inserter.
    1841. 

  1841. 	 * --variation: Allows to decide whether the block should be a production block, experimental, or beta. Defaults to Beta when arg not provided.
    1842. 

  1842. 	 *
    1843. 

  1843. 	 * ## BLOCK TYPE EXAMPLES
    1844. 

  1844. 	 *
    1845. 

  1845. 	 * wp jetpack scaffold block "Cool Block"
    1846. 

  1846. 	 * wp jetpack scaffold block "Amazing Rock" --slug="good-music" --description="Rock the best music on your site"
    1847. 

  1847. 	 * wp jetpack scaffold block "Jukebox" --keywords="music, audio, media"
    1848. 

  1848. 	 * wp jetpack scaffold block "Jukebox" --variation="experimental"
    1849. 

  1849. 	 *
    1850. 

  1850. 	 * @subcommand scaffold block
    1851. 

  1851. 	 * @synopsis <type> <title> [--slug] [--description] [--keywords] [--variation]
    1852. 

  1852. 	 *
    1853. 

  1853. 	 * @param array $args       Positional parameters, when strings are passed, wrap them in quotes.
    1854. 

  1854. 	 * @param array $assoc_args Associative parameters like --slug="nice-block".
    1855. 

  1855. 	 */
    1856. 

  1856. 	public function scaffold( $args, $assoc_args ) {
    1857. 

  1857. 		// It's ok not to check if it's set, because otherwise WPCLI exits earlier.
    1858. 

  1858. 		switch ( $args[0] ) {
    1859. 

  1859. 			case 'block':
    1860. 

  1860. 				$this->block( $args, $assoc_args );
    1861. 

  1861. 				break;
    1862. 

  1862. 			default:
    1863. 

  1863. 				/* translators: %s is the subcommand */
    1864. 

  1864. 				WP_CLI::error( sprintf( esc_html__( 'Invalid subcommand %s.', 'jetpack' ), $args[0] ) . ' 👻' );
    1865. 

  1865. 				exit( 1 );
    1866. 

  1866. 		}
    1867. 

  1867. 	}
    1868. 

  1868. 

  1869. 	/**
    1870. 

  1870. 	 * Creates the essential files in Jetpack to build a Gutenberg block.
    1871. 

  1871. 	 *
    1872. 

  1872. 	 * @param array $args       Positional parameters. Only one is used, that corresponds to the block title.
    1873. 

  1873. 	 * @param array $assoc_args Associative parameters defined in the scaffold() method.
    1874. 

  1874. 	 */
    1875. 

  1875. 	public function block( $args, $assoc_args ) {
    1876. 

  1876. 		if ( isset( $args[1] ) ) {
    1877. 

  1877. 			$title = ucwords( $args[1] );
    1878. 

  1878. 		} else {
    1879. 

  1879. 			WP_CLI::error( esc_html__( 'The title parameter is required.', 'jetpack' ) . ' 👻' );
    1880. 

  1880. 			exit( 1 );
    1881. 

  1881. 		}
    1882. 

  1882. 

  1883. 		$slug = isset( $assoc_args['slug'] )
    1884. 

  1884. 			? $assoc_args['slug']
    1885. 

  1885. 			: sanitize_title( $title );
    1886. 

  1886. 

  1887. 		$variation_options = array( 'production', 'experimental', 'beta' );
    1888. 

  1888. 		$variation         = ( isset( $assoc_args['variation'] ) && in_array( $assoc_args['variation'], $variation_options, true ) )
    1889. 

  1889. 			? $assoc_args['variation']
    1890. 

  1890. 			: 'beta';
    1891. 

  1891. 

  1892. 		if ( preg_match( '#^jetpack/#', $slug ) ) {
    1893. 

  1893. 			$slug = preg_replace( '#^jetpack/#', '', $slug );
    1894. 

  1894. 		}
    1895. 

  1895. 

  1896. 		if ( ! preg_match( '/^[a-z][a-z0-9\-]*$/', $slug ) ) {
    1897. 

  1897. 			WP_CLI::error( esc_html__( 'Invalid block slug. They can contain only lowercase alphanumeric characters or dashes, and start with a letter', 'jetpack' ) . ' 👻' );
    1898. 

  1898. 		}
    1899. 

  1899. 

  1900. 		global $wp_filesystem;
    1901. 

  1901. 		if ( ! WP_Filesystem() ) {
    1902. 

  1902. 			WP_CLI::error( esc_html__( "Can't write files", 'jetpack' ) . ' 😱' );
    1903. 

  1903. 		}
    1904. 

  1904. 

  1905. 		$path = JETPACK__PLUGIN_DIR . "extensions/blocks/$slug";
    1906. 

  1906. 

  1907. 		if ( $wp_filesystem->exists( $path ) && $wp_filesystem->is_dir( $path ) ) {
    1908. 

  1908. 			/* translators: %s is path to the conflicting block */
    1909. 

  1909. 			WP_CLI::error( sprintf( esc_html__( 'Name conflicts with the existing block %s', 'jetpack' ), $path ) . ' ⛔️' );
    1910. 

  1910. 			exit( 1 );
    1911. 

  1911. 		}
    1912. 

  1912. 

  1913. 		$wp_filesystem->mkdir( $path );
    1914. 

  1914. 

  1915. 		$hasKeywords = isset( $assoc_args['keywords'] );
    1916. 

  1916. 

  1917. 		$files = array(
    1918. 

  1918. 			"$path/$slug.php"     => $this->render_block_file(
    1919. 

  1919. 				'block-register-php',
    1920. 

  1920. 				array(
    1921. 

  1921. 					'slug'             => $slug,
    1922. 

  1922. 					'title'            => $title,
    1923. 

  1923. 					'underscoredSlug'  => str_replace( '-', '_', $slug ),
    1924. 

  1924. 					'underscoredTitle' => str_replace( ' ', '_', $title ),
    1925. 

  1925. 					'jetpackVersion'   => substr( JETPACK__VERSION, 0, strpos( JETPACK__VERSION, '.' ) ) . '.x',
    1926. 

  1926. 				)
    1927. 

  1927. 			),
    1928. 

  1928. 			"$path/index.js"      => $this->render_block_file(
    1929. 

  1929. 				'block-index-js',
    1930. 

  1930. 				array(
    1931. 

  1931. 					'slug'        => $slug,
    1932. 

  1932. 					'title'       => $title,
    1933. 

  1933. 					'description' => isset( $assoc_args['description'] )
    1934. 

  1934. 						? $assoc_args['description']
    1935. 

  1935. 						: $title,
    1936. 

  1936. 					'keywords'    => $hasKeywords
    1937. 

  1937. 					? array_map(
    1938. 

  1938. 						function( $keyword ) {
    1939. 

  1939. 								// Construction necessary for Mustache lists
    1940. 

  1940. 								return array( 'keyword' => trim( $keyword ) );
    1941. 

  1941. 						},
    1942. 

  1942. 						explode( ',', $assoc_args['keywords'], 3 )
    1943. 

  1943. 					)
    1944. 

  1944. 					: '',
    1945. 

  1945. 					'hasKeywords' => $hasKeywords,
    1946. 

  1946. 				)
    1947. 

  1947. 			),
    1948. 

  1948. 			"$path/editor.js"     => $this->render_block_file( 'block-editor-js' ),
    1949. 

  1949. 			"$path/editor.scss"   => $this->render_block_file(
    1950. 

  1950. 				'block-editor-scss',
    1951. 

  1951. 				array(
    1952. 

  1952. 					'slug'  => $slug,
    1953. 

  1953. 					'title' => $title,
    1954. 

  1954. 				)
    1955. 

  1955. 			),
    1956. 

  1956. 			"$path/edit.js"       => $this->render_block_file(
    1957. 

  1957. 				'block-edit-js',
    1958. 

  1958. 				array(
    1959. 

  1959. 					'title'     => $title,
    1960. 

  1960. 					'className' => str_replace( ' ', '', ucwords( str_replace( '-', ' ', $slug ) ) ),
    1961. 

  1961. 				)
    1962. 

  1962. 			),
    1963. 

  1963. 			"$path/icon.js"       => $this->render_block_file( 'block-icon-js' ),
    1964. 

  1964. 			"$path/attributes.js" => $this->render_block_file( 'block-attributes-js' ),
    1965. 

  1965. 		);
    1966. 

  1966. 

  1967. 		$files_written = array();
    1968. 

  1968. 

  1969. 		foreach ( $files as $filename => $contents ) {
    1970. 

  1970. 			if ( $wp_filesystem->put_contents( $filename, $contents ) ) {
    1971. 

  1971. 				$files_written[] = $filename;
    1972. 

  1972. 			} else {
    1973. 

  1973. 				/* translators: %s is a file name */
    1974. 

  1974. 				WP_CLI::error( sprintf( esc_html__( 'Error creating %s', 'jetpack' ), $filename ) );
    1975. 

  1975. 			}
    1976. 

  1976. 		}
    1977. 

  1977. 

  1978. 		if ( empty( $files_written ) ) {
    1979. 

  1979. 			WP_CLI::log( esc_html__( 'No files were created', 'jetpack' ) );
    1980. 

  1980. 		} else {
    1981. 

  1981. 			// Load index.json and insert the slug of the new block in its block variation array.
    1982. 

  1982. 			$block_list_path = JETPACK__PLUGIN_DIR . 'extensions/index.json';
    1983. 

  1983. 			$block_list      = $wp_filesystem->get_contents( $block_list_path );
    1984. 

  1984. 			if ( empty( $block_list ) ) {
    1985. 

  1985. 				/* translators: %s is the path to the file with the block list */
    1986. 

  1986. 				WP_CLI::error( sprintf( esc_html__( 'Error fetching contents of %s', 'jetpack' ), $block_list_path ) );
    1987. 

  1987. 			} elseif ( false === stripos( $block_list, $slug ) ) {
    1988. 

  1988. 				$new_block_list                   = json_decode( $block_list );
    1989. 

  1989. 				$new_block_list->{ $variation }[] = $slug;
    1990. 

  1990. 

  1991. 				// Format the JSON to match our coding standards.
    1992. 

  1992. 				$new_block_list_formatted = wp_json_encode( $new_block_list, JSON_PRETTY_PRINT ) . "\n";
    1993. 

  1993. 				$new_block_list_formatted = preg_replace_callback(
    1994. 

  1994. 					// Find all occurrences of multiples of 4 spaces a the start of the line.
    1995. 

  1995. 					'/^((?:    )+)/m',
    1996. 

  1996. 					function ( $matches ) {
    1997. 

  1997. 						// Replace each occurrence of 4 spaces with a tab character.
    1998. 

  1998. 						return str_repeat( "\t", substr_count( $matches[0], '    ' ) );
    1999. 

  1999. 					},
    2000. 

  2000. 					$new_block_list_formatted
    2001. 

  2001. 				);
    2002. 

  2002. 

  2003. 				if ( ! $wp_filesystem->put_contents( $block_list_path, $new_block_list_formatted ) ) {
    2004. 

  2004. 					/* translators: %s is the path to the file with the block list */
    2005. 

  2005. 					WP_CLI::error( sprintf( esc_html__( 'Error writing new %s', 'jetpack' ), $block_list_path ) );
    2006. 

  2006. 				}
    2007. 

  2007. 			}
    2008. 

  2008. 

  2009. 			if ( 'beta' === $variation || 'experimental' === $variation ) {
    2010. 

  2010. 				$block_constant = sprintf(
    2011. 

  2011. 					/* translators: the placeholder is a constant name */
    2012. 

  2012. 					esc_html__( 'To load the block, add the constant %1$s as true to your wp-config.php file', 'jetpack' ),
    2013. 

  2013. 					( 'beta' === $variation ? 'JETPACK_BETA_BLOCKS' : 'JETPACK_EXPERIMENTAL_BLOCKS' )
    2014. 

  2014. 				);
    2015. 

  2015. 			} else {
    2016. 

  2016. 				$block_constant = '';
    2017. 

  2017. 			}
    2018. 

  2018. 

  2019. 			WP_CLI::success(
    2020. 

  2020. 				sprintf(
    2021. 

  2021. 					/* translators: the placeholders are a human readable title, and a series of words separated by dashes */
    2022. 

  2022. 					esc_html__( 'Successfully created block %1$s with slug %2$s', 'jetpack' ) . ' 🎉' . "\n" .
    2023. 

  2023. 					"--------------------------------------------------------------------------------------------------------------------\n" .
    2024. 

  2024. 					/* translators: the placeholder is a directory path */
    2025. 

  2025. 					esc_html__( 'The files were created at %3$s', 'jetpack' ) . "\n" .
    2026. 

  2026. 					esc_html__( 'To start using the block, build the blocks with pnpm run build-extensions', 'jetpack' ) . "\n" .
    2027. 

  2027. 					/* translators: the placeholder is a file path */
    2028. 

  2028. 					esc_html__( 'The block slug has been added to the %4$s list at %5$s', 'jetpack' ) . "\n" .
    2029. 

  2029. 					'%6$s' . "\n" .
    2030. 

  2030. 					/* translators: the placeholder is a URL */
    2031. 

  2031. 					"\n" . esc_html__( 'Read more at %7$s', 'jetpack' ) . "\n",
    2032. 

  2032. 					$title,
    2033. 

  2033. 					$slug,
    2034. 

  2034. 					$path,
    2035. 

  2035. 					$variation,
    2036. 

  2036. 					$block_list_path,
    2037. 

  2037. 					$block_constant,
    2038. 

  2038. 					'https://github.com/Automattic/jetpack/blob/master/extensions/README.md#develop-new-blocks'
    2039. 

  2039. 				) . '--------------------------------------------------------------------------------------------------------------------'
    2040. 

  2040. 			);
    2041. 

  2041. 		}
    2042. 

  2042. 	}
    2043. 

  2043. 

  2044. 	/**
    2045. 

  2045. 	 * Built the file replacing the placeholders in the template with the data supplied.
    2046. 

  2046. 	 *
    2047. 

  2047. 	 * @param string $template
    2048. 

  2048. 	 * @param array  $data
    2049. 

  2049. 	 *
    2050. 

  2050. 	 * @return string mixed
    2051. 

  2051. 	 */
    2052. 

  2052. 	private static function render_block_file( $template, $data = array() ) {
    2053. 

  2053. 		return \WP_CLI\Utils\mustache_render( JETPACK__PLUGIN_DIR . "wp-cli-templates/$template.mustache", $data );
    2054. 

  2054. 	}
    2055. 

  2055. }
    2056. 

  2056. 

  2057. /*
    2058. 

  2058.  * Standard "ask for permission to continue" function.
    2059. 

  2059.  * If action cancelled, ask if they need help.
    2060. 

  2060.  *
    2061. 

  2061.  * Written outside of the class so it's not listed as an executable command w/ 'wp jetpack'
    2062. 

  2062.  *
    2063. 

  2063.  * @param $flagged   bool   false = normal option | true = flagged by get_jetpack_options_for_reset()
    2064. 

  2064.  * @param $error_msg string (optional)
    2065. 

  2065.  */
    2066. 

  2066. function jetpack_cli_are_you_sure( $flagged = false, $error_msg = false ) {
    2067. 

  2067. 	$cli = new Jetpack_CLI();
    2068. 

  2068. 

  2069. 	// Default cancellation message
    2070. 

  2070. 	if ( ! $error_msg ) {
    2071. 

  2071. 		$error_msg =
    2072. 

  2072. 			__( 'Action cancelled. Have a question?', 'jetpack' )
    2073. 

  2073. 			. ' '
    2074. 

  2074. 			. $cli->green_open
    2075. 

  2075. 			. 'jetpack.com/support'
    2076. 

  2076. 			. $cli->color_close;
    2077. 

  2077. 	}
    2078. 

  2078. 

  2079. 	if ( ! $flagged ) {
    2080. 

  2080. 		$prompt_message = _x( 'Are you sure? This cannot be undone. Type "yes" to continue:', '"yes" is a command - do not translate.', 'jetpack' );
    2081. 

  2081. 	} else {
    2082. 

  2082. 		$prompt_message = _x( 'Are you sure? Modifying this option may disrupt your Jetpack connection. Type "yes" to continue.', '"yes" is a command - do not translate.', 'jetpack' );
    2083. 

  2083. 	}
    2084. 

  2084. 

  2085. 	WP_CLI::line( $prompt_message );
    2086. 

  2086. 	$handle = fopen( 'php://stdin', 'r' );
    2087. 

  2087. 	$line   = fgets( $handle );
    2088. 

  2088. 	if ( 'yes' != trim( $line ) ) {
    2089. 

  2089. 		WP_CLI::error( $error_msg );
    2090. 

  2090. 	}
    2091. 

  2091. }
    2092. 

  2092.