PageEditorByHackmd.jsx 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411
  1. import React from 'react';
  2. import PropTypes from 'prop-types';
  3. import loggerFactory from '@alias/logger';
  4. import { withTranslation } from 'react-i18next';
  5. import AppContainer from '../services/AppContainer';
  6. import PageContainer from '../services/PageContainer';
  7. import EditorContainer from '../services/EditorContainer';
  8. import { withUnstatedContainers } from './UnstatedUtils';
  9. import HackmdEditor from './PageEditorByHackmd/HackmdEditor';
  10. const logger = loggerFactory('growi:PageEditorByHackmd');
  11. class PageEditorByHackmd extends React.Component {
  12. constructor(props) {
  13. super(props);
  14. this.state = {
  15. isInitialized: false,
  16. isInitializing: false,
  17. // for error
  18. hasError: false,
  19. errorMessage: '',
  20. errorReason: '',
  21. };
  22. this.getHackmdUri = this.getHackmdUri.bind(this);
  23. this.startToEdit = this.startToEdit.bind(this);
  24. this.resumeToEdit = this.resumeToEdit.bind(this);
  25. this.onSaveWithShortcut = this.onSaveWithShortcut.bind(this);
  26. this.hackmdEditorChangeHandler = this.hackmdEditorChangeHandler.bind(this);
  27. this.penpalErrorOccuredHandler = this.penpalErrorOccuredHandler.bind(this);
  28. }
  29. componentWillMount() {
  30. this.props.appContainer.registerComponentInstance('PageEditorByHackmd', this);
  31. }
  32. /**
  33. * return markdown document of HackMD
  34. * @return {Promise<string>}
  35. */
  36. getMarkdown() {
  37. const { t } = this.props;
  38. if (!this.state.isInitialized) {
  39. return Promise.reject(new Error(t('hackmd.not_initialized')));
  40. }
  41. return this.hackmdEditor.getValue();
  42. }
  43. /**
  44. * reset initialized status
  45. */
  46. reset() {
  47. this.setState({ isInitialized: false });
  48. }
  49. getHackmdUri() {
  50. const envVars = this.props.appContainer.getConfig().env;
  51. return envVars.HACKMD_URI;
  52. }
  53. get isResume() {
  54. const { pageContainer } = this.props;
  55. const {
  56. pageIdOnHackmd, hasDraftOnHackmd, isHackmdDraftUpdatingInRealtime,
  57. } = pageContainer.state;
  58. const isPageExistsOnHackmd = (pageIdOnHackmd != null);
  59. return (isPageExistsOnHackmd && hasDraftOnHackmd) || isHackmdDraftUpdatingInRealtime;
  60. }
  61. /**
  62. * Start integration with HackMD
  63. */
  64. async startToEdit() {
  65. const { pageContainer } = this.props;
  66. const hackmdUri = this.getHackmdUri();
  67. if (hackmdUri == null) {
  68. // do nothing
  69. return;
  70. }
  71. this.setState({
  72. isInitialized: false,
  73. isInitializing: true,
  74. });
  75. const params = {
  76. pageId: pageContainer.state.pageId,
  77. };
  78. try {
  79. const res = await this.props.appContainer.apiPost('/hackmd.integrate', params);
  80. if (!res.ok) {
  81. throw new Error(res.error);
  82. }
  83. await pageContainer.setState({
  84. pageIdOnHackmd: res.pageIdOnHackmd,
  85. revisionIdHackmdSynced: res.revisionIdHackmdSynced,
  86. });
  87. }
  88. catch (err) {
  89. pageContainer.showErrorToastr(err);
  90. this.setState({
  91. hasError: true,
  92. errorMessage: 'GROWI server failed to connect to HackMD.',
  93. errorReason: err.toString(),
  94. });
  95. }
  96. this.setState({
  97. isInitialized: true,
  98. isInitializing: false,
  99. });
  100. }
  101. /**
  102. * Start to edit w/o any api request
  103. */
  104. resumeToEdit() {
  105. this.setState({ isInitialized: true });
  106. }
  107. /**
  108. * Reset draft
  109. */
  110. async discardChanges() {
  111. const { pageContainer } = this.props;
  112. const { pageId } = pageContainer.state;
  113. try {
  114. const res = await this.props.appContainer.apiPost('/hackmd.discard', { pageId });
  115. if (!res.ok) {
  116. throw new Error(res.error);
  117. }
  118. this.props.pageContainer.setState({
  119. hasDraftOnHackmd: false,
  120. pageIdOnHackmd: res.pageIdOnHackmd,
  121. revisionIdHackmdSynced: res.revisionIdHackmdSynced,
  122. });
  123. }
  124. catch (err) {
  125. logger.error(err);
  126. pageContainer.showErrorToastr(err);
  127. }
  128. }
  129. /**
  130. * save and update state of containers
  131. * @param {string} markdown
  132. */
  133. async onSaveWithShortcut(markdown) {
  134. const { pageContainer, editorContainer } = this.props;
  135. const optionsToSave = editorContainer.getCurrentOptionsToSave();
  136. try {
  137. // disable unsaved warning
  138. editorContainer.disableUnsavedWarning();
  139. // eslint-disable-next-line no-unused-vars
  140. const { page, tags } = await pageContainer.save(markdown, optionsToSave);
  141. logger.debug('success to save');
  142. pageContainer.showSuccessToastr();
  143. // update state of EditorContainer
  144. editorContainer.setState({ tags });
  145. }
  146. catch (error) {
  147. logger.error('failed to save', error);
  148. pageContainer.showErrorToastr(error);
  149. }
  150. }
  151. /**
  152. * onChange event of HackmdEditor handler
  153. */
  154. async hackmdEditorChangeHandler(body) {
  155. const hackmdUri = this.getHackmdUri();
  156. const { pageContainer, editorContainer } = this.props;
  157. if (hackmdUri == null) {
  158. // do nothing
  159. return;
  160. }
  161. // do nothing if contents are same
  162. if (pageContainer.state.markdown === body) {
  163. return;
  164. }
  165. // enable unsaved warning
  166. editorContainer.enableUnsavedWarning();
  167. const params = {
  168. pageId: pageContainer.state.pageId,
  169. };
  170. try {
  171. await this.props.appContainer.apiPost('/hackmd.saveOnHackmd', params);
  172. }
  173. catch (err) {
  174. logger.error(err);
  175. }
  176. }
  177. penpalErrorOccuredHandler(error) {
  178. const { pageContainer, t } = this.props;
  179. pageContainer.showErrorToastr(error);
  180. this.setState({
  181. hasError: true,
  182. errorMessage: t('hackmd.fail_to_connect'),
  183. errorReason: error.toString(),
  184. });
  185. }
  186. renderPreInitContent() {
  187. const hackmdUri = this.getHackmdUri();
  188. const { pageContainer, t } = this.props;
  189. const {
  190. revisionId, revisionIdHackmdSynced, remoteRevisionId,
  191. } = pageContainer.state;
  192. let content;
  193. /*
  194. * HackMD is not setup
  195. */
  196. if (hackmdUri == null) {
  197. content = (
  198. <div>
  199. <p className="text-center hackmd-status-label"><i className="fa fa-file-text"></i> { t('hackmd.not_set_up')}</p>
  200. <a href="https://docs.growi.org/ja/admin-guide/">GROWI Docs 管理者ガイド</a>
  201. </div>
  202. );
  203. }
  204. /*
  205. * Resume to edit or discard changes
  206. */
  207. else if (this.isResume) {
  208. const isHackmdDocumentOutdated = revisionIdHackmdSynced !== remoteRevisionId;
  209. content = (
  210. <div>
  211. <p className="text-center hackmd-status-label"><i className="fa fa-file-text"></i> HackMD is READY!</p>
  212. <p className="text-center"><strong>{t('hackmd.unsaved_draft')}</strong></p>
  213. { isHackmdDocumentOutdated && (
  214. <div className="card border-warning">
  215. <div className="card-header bg-warning"><i className="icon-fw icon-info"></i> {t('hackmd.draft_outdated')}</div>
  216. <div className="card-body text-center">
  217. {t('hackmd.based_on_revision')}&nbsp;
  218. <a href={`?revision=${revisionIdHackmdSynced}`}><span className="badge badge-secondary">{revisionIdHackmdSynced.substr(-8)}</span></a>
  219. <div className="text-center mt-3">
  220. <button
  221. className="btn btn-link btn-view-outdated-draft p-0"
  222. type="button"
  223. disabled={this.state.isInitializing}
  224. onClick={() => { return this.resumeToEdit() }}
  225. >
  226. {t('hackmd.view_outdated_draft')}
  227. </button>
  228. </div>
  229. </div>
  230. </div>
  231. ) }
  232. { !isHackmdDocumentOutdated && (
  233. <div className="text-center hackmd-resume-button-container mb-3">
  234. <button
  235. className="btn btn-success btn-lg waves-effect waves-light"
  236. type="button"
  237. disabled={this.state.isInitializing}
  238. onClick={() => { return this.resumeToEdit() }}
  239. >
  240. <span className="btn-label"><i className="icon-fw icon-control-end"></i></span>
  241. <span className="btn-text">{t('hackmd.resume_to_edit')}</span>
  242. </button>
  243. </div>
  244. ) }
  245. <div className="text-center hackmd-discard-button-container mb-3">
  246. <button
  247. className="btn btn-outline-secondary btn-lg waves-effect waves-light"
  248. type="button"
  249. onClick={() => { return this.discardChanges() }}
  250. >
  251. <span className="btn-label"><i className="icon-fw icon-control-start"></i></span>
  252. <span className="btn-text">{t('hackmd.discard_changes')}</span>
  253. </button>
  254. </div>
  255. </div>
  256. );
  257. }
  258. /*
  259. * Start to edit
  260. */
  261. else {
  262. const isRevisionOutdated = revisionId !== remoteRevisionId;
  263. content = (
  264. <div>
  265. <p className="text-muted text-center hackmd-status-label"><i className="fa fa-file-text"></i> HackMD is READY!</p>
  266. <div className="text-center hackmd-start-button-container mb-3">
  267. <button
  268. className="btn btn-info btn-lg waves-effect waves-light"
  269. type="button"
  270. disabled={isRevisionOutdated || this.state.isInitializing}
  271. onClick={() => { return this.startToEdit() }}
  272. >
  273. <span className="btn-label"><i className="icon-fw icon-paper-plane"></i></span>
  274. {t('hackmd.start_to_edit')}
  275. </button>
  276. </div>
  277. <p className="text-center">{t('hackmd.clone_page_content')}</p>
  278. </div>
  279. );
  280. }
  281. return (
  282. <div className="hackmd-preinit d-flex justify-content-center align-items-center">
  283. {content}
  284. </div>
  285. );
  286. }
  287. render() {
  288. const hackmdUri = this.getHackmdUri();
  289. const { pageContainer, t } = this.props;
  290. const {
  291. markdown, pageIdOnHackmd,
  292. } = pageContainer.state;
  293. let content;
  294. if (this.state.isInitialized) {
  295. content = (
  296. <HackmdEditor
  297. ref={(c) => { this.hackmdEditor = c }}
  298. hackmdUri={hackmdUri}
  299. pageIdOnHackmd={pageIdOnHackmd}
  300. initializationMarkdown={this.isResume ? null : markdown}
  301. onChange={this.hackmdEditorChangeHandler}
  302. onSaveWithShortcut={(document) => {
  303. this.onSaveWithShortcut(document);
  304. }}
  305. onPenpalErrorOccured={this.penpalErrorOccuredHandler}
  306. >
  307. </HackmdEditor>
  308. );
  309. }
  310. else {
  311. content = this.renderPreInitContent();
  312. }
  313. return (
  314. <div className="position-relative">
  315. {content}
  316. { this.state.hasError && (
  317. <div className="hackmd-error position-absolute d-flex flex-column justify-content-center align-items-center">
  318. <div className="bg-box p-5 text-center">
  319. <h2 className="text-warning"><i className="icon-fw icon-exclamation"></i> {t('hackmd.integration_failed')}</h2>
  320. <h4>{this.state.errorMessage}</h4>
  321. <p className="card well text-danger">
  322. {this.state.errorReason}
  323. </p>
  324. {/* eslint-disable-next-line react/no-danger */}
  325. <p dangerouslySetInnerHTML={{ __html: t('hackmd.check_configuration') }} />
  326. </div>
  327. </div>
  328. ) }
  329. </div>
  330. );
  331. }
  332. }
  333. /**
  334. * Wrapper component for using unstated
  335. */
  336. const PageEditorByHackmdWrapper = withUnstatedContainers(PageEditorByHackmd, [AppContainer, PageContainer, EditorContainer]);
  337. PageEditorByHackmd.propTypes = {
  338. t: PropTypes.func.isRequired, // i18next
  339. appContainer: PropTypes.instanceOf(AppContainer).isRequired,
  340. pageContainer: PropTypes.instanceOf(PageContainer).isRequired,
  341. editorContainer: PropTypes.instanceOf(EditorContainer).isRequired,
  342. };
  343. export default withTranslation()(PageEditorByHackmdWrapper);