Source: index.js

  1. /* KoreanSchool
  2. Copyright (C) 2018  Seungjae Park
  4. This program is free software: you can redistribute it and/or modify
  5. it under the terms of the GNU General Public License as published by
  6. the Free Software Foundation, either version 3 of the License, or
  7. (at your option) any later version.
  9. This program is distributed in the hope that it will be useful,
  10. but WITHOUT ANY WARRANTY; without even the implied warranty of
  11. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12. GNU General Public License for more details.
  14. You should have received a copy of the GNU General Public License
  15. along with this program.  If not, see <http://www.gnu.org/licenses/>. */
  17. const fs = require('fs');
  18. const iconv = require('iconv-lite');
  19. const jsdom = require('jsdom');
  20. const path = require('path');
  21. const puppeteer = require('puppeteer');
  22. const request = require('request');
  24. const { Dimigo } = require('./utils');
  26. const { JSDOM } = jsdom;
  27. const getLastLine = buffer => buffer.slice(buffer.lastIndexOf('\n'));
  29. const schools = JSON.parse(getLastLine(fs.readFileSync(path.resolve(__dirname, '../data/schools.min.json'))));
  31. const alias = {
  32.   office: {
  33.     서울시: '서울특별시',
  34.     부산시: '부산광역시',
  35.     대구시: '대구광역시',
  36.     인천시: '인천광역시',
  37.     광주시: '광주광역시',
  38.     대전시: '대전광역시',
  39.     울산시: '울산광역시',
  40.     세종시: '세종특별자치시',
  41.     세종특별시: '세종특별자치시',
  42.     충북: '충청북도',
  43.     충남: '충청남도',
  44.     전북: '전라북도',
  45.     전남: '전라남도',
  46.     경북: '경상북도',
  47.     경남: '경상남도',
  48.     제주시: '제주특별자치도',
  49.     제주특별시: '제주특별자치도',
  50.   },
  51. };
  53. const cache = {
  54.   comcigan: {},
  55. };
  57. /**
  58.  * @typedef {Object} ComciganData
  59.  * @property {number} 교사수
  60.  * @property {Array.<string>} 성명
  61.  * @property {Array.<number>} 학급수
  62.  * @property {Array.<Array.<number>>} 요일별시수
  63.  * @property {Array.<string>} 긴과목명
  64.  * @property {Array.<string>} 과목명
  65.  * @property {Array.<Array>} 시간표
  66.  * @property {Array.<number>} 전일제
  67.  * @property {string} 버젼
  68.  * @property {number} 동시수업수
  69.  * @property {Array.<Array.<number>>} 담임
  70.  * @property {Array.<number>} 가상학급수
  71.  * @property {number} 특별실수
  72.  * @property {string} 열람제한일
  73.  * @property {string} 저장일
  74.  * @property {string} 학기시작일자
  75.  * @property {string} 학교명
  76.  * @property {string} 지역명
  77.  * @property {number} 학년도
  78.  * @property {Array.<string>} 복수교사
  79.  * @property {string} 시작일
  80.  * @property {Array.<string>} 일과시간
  81.  * @property {Array.<Array.<number|string>>} 일자자료
  82.  * @property {number} 오늘r
  83.  * @property {Array.<Array>} 학급시간표
  84.  * @property {Array.<Array>} 교사시간표
  85.  */
  87. /**
  88.  * @typedef {Object} SchoolData
  89.  * @property {string} code
  90.  * @property {string} office
  91.  * @property {string} officeDomain
  92.  * @property {string} name
  93.  */
  95. /**
  96.  * @typedef {Object} SchoolInformation
  97.  * @property {?string} address
  98.  * @property {?string} area
  99.  * @property {?string} class
  100.  * @property {?string} office
  101.  * @property {?string} phone
  102.  * @property {?string} fax
  103.  * @property {?string} establishmentDate
  104.  * @property {?string} establishmentType
  105.  * @property {?string} schoolAnniversary
  106.  * @property {?string} schoolType
  107.  * @property {?string} site
  108.  */
  110. /**
  111.  * @typedef {Object} SchoolMeal
  112.  * @property {?string} breakfast
  113.  * @property {?string} lunch
  114.  * @property {?string} dinner
  115.  */
  117. /**
  118.  * @typedef {Object} SchoolSchedule
  119.  * @property {?string} subject
  120.  * @property {?string} subjectOriginal
  121.  * @property {?string} teacher
  122.  * @property {boolean} isChanged
  123.  */
  125. /**
  126.  * @typedef {Object} SchoolTeacherSchedule
  127.  * @property {number} grade
  128.  * @property {number} room
  129.  * @property {?string} subject
  130.  * @property {?string} subjectOriginal
  131.  * @property {boolean} isChanged
  132.  */
  134. /**
  135.  * Returns all matched school data from DB with school's office and name.
  136.  * @example
  137.  * school.findAll('경기도', '백석고');
  138.  * // [
  139.  * //   {
  140.  * //     code: 'J100000564',
  141.  * //     office: '경기도',
  142.  * //     officeDomain: 'goe.go',
  143.  * //     name: '백석고등학교'
  144.  * //   },
  145.  * //   {
  146.  * //     code: 'J100005280',
  147.  * //     office: '경기도',
  148.  * //     officeDomain: 'goe.go',
  149.  * //     name: '양주백석고등학교'
  150.  * //   }
  151.  * // ]
  152.  * @function
  153.  * @param {string} office
  154.  * @param {string} schoolName
  155.  * @param {string} [useAlias=true]
  156.  * @returns {?Array.<SchoolData>}
  157.  */
  158. const findAll = (office, schoolName, useAlias = true) => {
  159.   const matches = [];
  160.   for (let i = 0, len = schools.length; i < len; i += 1) {
  161.     const school = schools[i];
  162.     let check = false;
  163.     if (typeof office === 'string') {
  164.       if (useAlias) {
  165.         if (office in alias.office) {
  166.           check = school.office.search(alias.office[office]) >= 0;
  167.         } else {
  168.           check = school.office.search(office) >= 0;
  169.         }
  170.       } else {
  171.         check = school.office.search(office) >= 0;
  172.       }
  173.     } else if (typeof office === 'object' && office instanceof RegExp) {
  174.       check = office.test(school.office);
  175.     }
  176.     if (check) {
  177.       if (typeof schoolName === 'string') {
  178.         if (useAlias) {
  179.           check = school.name.replace(/초$/, '초등학교')
  180.             .replace(/중$/, '중학교')
  181.             .replace(/고$/, '고등학교')
  182.             .replace(/여자?중학교/, '여자중학교')
  183.             .replace(/여자?고등학교/, '여자고등학교')
  184.             .search(schoolName) >= 0;
  185.         } else {
  186.           check = school.name.search(schoolName) >= 0;
  187.         }
  188.       } else if (typeof schoolName === 'object' && schoolName instanceof RegExp) {
  189.         check = schoolName.test(school.name);
  190.       }
  191.       if (check) {
  192.         matches.push(school);
  193.       }
  194.     }
  195.   }
  196.   if (matches.length > 0) {
  197.     return matches;
  198.   }
  199.   return null;
  200. };
  202. /**
  203.  * Returns the best matched school data in the DB with school's office and name.
  204.  * @example
  205.  * school.find('경기도', '백석고');
  206.  * // {
  207.  * //   code: 'J100000564',
  208.  * //   office: '경기도',
  209.  * //   officeDomain: 'goe.go',
  210.  * //   name: '백석고등학교'
  211.  * // }
  212.  * @function
  213.  * @param {string} office
  214.  * @param {string} schoolName
  215.  * @param {string} [useAlias=true]
  216.  * @returns {?SchoolData}
  217.  */
  218. const find = (office, schoolName, useAlias = true) => {
  219.   let schoolNameLength;
  220.   if (useAlias) {
  221.     schoolNameLength = schoolName.replace(/초$/, '초등학교')
  222.       .replace(/중$/, '중학교')
  223.       .replace(/고$/, '고등학교')
  224.       .replace(/여자?중학교/, '여자중학교')
  225.       .replace(/여자?고등학교/, '여자고등학교').length;
  226.   } else {
  227.     schoolNameLength = schoolName.length;
  228.   }
  229.   const schoolData = findAll(office, schoolName, useAlias);
  230.   if (schoolData) {
  231.     return schoolData.reduce((accumulator, currentValue) => {
  232.       if (schoolNameLength / accumulator.length < schoolNameLength / currentValue.length) {
  233.         return currentValue;
  234.       }
  235.       return accumulator;
  236.     });
  237.   }
  238.   return null;
  239. };
  241. /**
  242.  * Returns all school data from DB.
  243.  * @example
  244.  * school.getAll();
  245.  * // [
  246.  * //   ...
  247.  * //   { code: 'J100000564',
  248.  * //   office: '경기도',
  249.  * //   officeDomain: 'goe.go',
  250.  * //   name: '백석고등학교' }
  251.  * //   ...
  252.  * // ]
  253.  * @function
  254.  * @returns {Array.<SchoolData>}
  255.  */
  256. const getAll = () => schools;
  258. /**
  259.  * Returns the school data from Comcigan server.
  260.  * @example
  261.  * await school.getComciganData(find('경기도', '백석고'));
  262.  * // ComciganData {}
  263.  * @async
  264.  * @function
  265.  * @param {SchoolData} school
  266.  * @returns {?ComciganData}
  267.  */
  268. const getComciganData = school => new Promise(async (resolve) => {
  269.   const UPDATE_TIME = 5 * 60 * 1000; // 5 minutes
  270.   const { code } = school;
  271.   const { comcigan } = cache;
  272.   if (code in comcigan && comcigan[code].date > Date.now() - UPDATE_TIME) {
  273.     resolve(JSON.parse(comcigan[code].data));
  274.   } else {
  275.     const browser = await puppeteer.launch();
  276.     const page = await browser.newPage();
  277.     page.on('response', async (response) => {
  278.       const content = await response.text();
  279.       if (content.includes('{"학교검색":')) {
  280.         page.click('tr.검색 > td > a').catch(() => { }); // puppeteer bug: https://github.com/GoogleChrome/puppeteer/issues/1769
  281.       }
  282.       if (content.includes('{"교사수":')) {
  283.         const html = await page.content();
  284.         await browser.close();
  285.         let data = content.split('\n')[0]
  286.           .replace(/(자료\d+)"/g, ($, $1) => {
  287.             const matches = html.match(new RegExp(`([\\w가-힣]+)\\s*=\\s*자료\\.${$1}`));
  288.             return matches ? `${matches[1]}"` : $;
  289.           })
  290.           .replace(/"자료\d+":("\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}")/, '"저장일":$1')
  291.           .replace('"원자료"', '"시간표"')
  292.           .replace('"일일자료"', '"학급시간표"');
  293.         data = data.replace(/자료\d+"/g, $ => (data.split($).length === 2 ? '교사시간표"' : '과목명"'));
  294.         comcigan[code] = {
  295.           data,
  296.           date: Date.now(),
  297.         };
  298.         resolve(JSON.parse(data));
  299.       }
  300.     });
  301.     await page.goto('http://comci.kr:4081/st');
  302.     await page.type('#sc', school.name);
  303.     await page.click('input[value=\'검색\']');
  304.   }
  305. });
  307. /**
  308.  * Returns the school information from School Info.
  309.  * @example
  310.  * await school.getInformation(find('경기도', '백석고'));
  311.  * // {
  312.  * //   address: '경기도 고양시 일산동구 강촌로 115',
  313.  * //   area: '경기',
  314.  * //   class: '고',
  315.  * //   office: '경기도교육청',
  316.  * //   phone: '031-901-0506',
  317.  * //   fax: '031-901-0501',
  318.  * //   establishmentDate: '1992-09-08',
  319.  * //   establishmentType: '공립',
  320.  * //   schoolAnniversary: '1992-09-08',
  321.  * //   schoolType: '단설',
  322.  * //   site: 'http://www.baekseok.hs.kr'
  323.  * // }
  324.  * @async
  325.  * @function
  326.  * @param {SchoolData} school
  327.  * @returns {?SchoolInformation}
  328.  */
  329. const getInformation = school => new Promise((resolve) => {
  330.   request.post({
  331.     url: `https://www.schoolinfo.go.kr/ei/ss/Pneiss_b01_s0.do?HG_CD=${school.code}`,
  332.     encoding: null,
  333.     headers: { 'User-Agent': 'Mozilla/5.0' },
  334.   }, (err, httpResponse, body) => {
  335.     if (err) {
  336.       resolve(null);
  337.     } else {
  338.       const { document } = (new JSDOM(iconv.decode(body, 'euc-kr'))).window;
  339.       const data = { // default values
  340.         address: null,
  341.         area: document.querySelector('.School_Division .mapD_Area').textContent || null,
  342.         class: document.querySelector('.School_Division .mapD_Class').textContent || null,
  343.         office: null,
  344.         phone: null,
  345.         fax: null,
  346.         establishmentDate: null,
  347.         establishmentType: null,
  348.         schoolAnniversary: null,
  349.         schoolType: null,
  350.         site: null,
  351.       };
  352.       document.querySelectorAll('.School_Data li').forEach((element) => {
  353.         if (element.textContent.search('학교주소') >= 0) {
  354.           data.address = element.textContent.replace(/^\s*학교주소\s*/, '').replace(/\s*$/, '');
  355.         } else if (element.textContent.search('관할교육청') >= 0) {
  356.           data.office = element.textContent.replace(/^\s*관할교육청\s*/, '').replace(/\s*$/, '');
  357.         } else if (element.textContent.search('전화/팩스') >= 0) {
  358.           const str = element.textContent.replace(/^\s*전화\/팩스\s*/, '').replace(/\s*$/, '');
  359.           if (str.search('전화') >= 0) {
  360.             [, data.phone] = str.match(/전화([0-9-]+)/);
  361.           }
  362.           if (str.search('팩스') >= 0) {
  363.             [, data.fax] = str.match(/팩스([0-9-]+)/);
  364.           }
  365.         } else if (element.textContent.search('설립일') >= 0) {
  366.           data.establishmentDate = element.textContent.replace(/^\s*설립일\s*/, '').replace(/\s*$/, '');
  367.         } else if (element.textContent.search('설립구분') >= 0) {
  368.           data.establishmentType = element.textContent.replace(/^\s*설립구분\s*/, '').replace(/\s*$/, '');
  369.         } else if (element.textContent.search('개교기념일') >= 0) {
  370.           data.schoolAnniversary = element.textContent.replace(/^\s*개교기념일\s*/, '').replace(/\s*$/, '');
  371.         } else if (element.textContent.search('설립유형') >= 0) {
  372.           data.schoolType = element.textContent.replace(/^\s*설립유형\s*/, '').replace(/\s*$/, '');
  373.         } else if (element.textContent.search('홈페이지') >= 0) {
  374.           data.site = element.textContent.replace(/^\s*홈페이지\s*/, '').replace(/\s*$/, '');
  375.         }
  376.       });
  377.       resolve(data);
  378.     }
  379.   });
  380. });
  382. /**
  383.  * Returns the school monthly meals.
  384.  * @example
  385.  * await school.getMeals(find('경기도', '백석고'), new Date());
  386.  * // [
  387.  * //   {
  388.  * //     breakfast: null,
  389.  * //     lunch: '보리밥_H\n어묵매운탕_H1.5.6.8.9.13.\n콘치즈떡갈비_H1.2.5.6.10.13.15.16.',
  390.  * //     dinner: null
  391.  * //   }
  392.  * //   ...
  393.  * // ]
  394.  * @async
  395.  * @function
  396.  * @param {SchoolData} school
  397.  * @param {Date} date
  398.  * @returns {?Array.<SchoolMeal>}
  399.  */
  400. const getMeals = (school, date) => {
  401.   if (school.code === 'J100000855') {
  402.     return Dimigo.getMeals(date);
  403.   }
  404.   return new Promise((resolve) => {
  405.     request.get({
  406.       url: `http://stu.${school.officeDomain}.kr/sts_sci_md00_001.do`,
  407.       form: {
  408.         schulCode: school.code,
  409.         schulCrseScCode: 4,
  410.         ay: date.getFullYear(),
  411.         mm: (`0${date.getMonth() + 1}`).substr(-2),
  412.       },
  413.     }, (err, httpResponse, body) => {
  414.       if (err) {
  415.         resolve(null);
  416.       } else {
  417.         const { document } = (new JSDOM(body)).window;
  418.         const meals = [];
  419.         document.querySelectorAll('.tbl_type3 tbody tr td div').forEach((element) => {
  420.           const content = element.innerHTML.split('<br>').join('\n').split('&amp;').join('&');
  421.           if (content.trim()) {
  422.             const breakfast = (content.match(/\[조식\][^[]+/) || [''])[0].replace(/\[조식\]\s*/, '').replace(/\s*\[/, '');
  423.             const lunch = (content.match(/\[중식\][^[]+/) || [''])[0].replace(/\[중식\]\s*/, '').replace(/\s*\[/, '');
  424.             const dinner = (content.match(/\[석식\][^[]+/) || [''])[0].replace(/\[석식\]\s*/, '');
  425.             meals[Number(content.match(/^\d+/)[0]) - 1] = {
  426.               breakfast: breakfast || null,
  427.               lunch: lunch || null,
  428.               dinner: dinner || null,
  429.             };
  430.           }
  431.         });
  432.         resolve(meals);
  433.       }
  434.     });
  435.   });
  436. };
  438. /**
  439.  * Returns the school daily meal.
  440.  * @example
  441.  * await school.getMeal(find('경기도', '백석고'), new Date());
  442.  * // {
  443.  * //   breakfast: null,
  444.  * //   lunch: '보리밥_H\n어묵매운탕_H1.5.6.8.9.13.\n콘치즈떡갈비_H1.2.5.6.10.13.15.16.',
  445.  * //   dinner: null
  446.  * // }
  447.  * @async
  448.  * @function
  449.  * @param {SchoolData} school
  450.  * @param {Date} date
  451.  * @returns {?SchoolMeal}
  452.  */
  453. const getMeal = (school, date) => {
  454.   if (school.code === 'J100000855') {
  455.     return Dimigo.getMeal(date);
  456.   }
  457.   return new Promise(async (resolve) => {
  458.     const meals = await getMeals(school, date);
  459.     if (meals) {
  460.       resolve(meals[date.getDate() - 1]);
  461.     } else {
  462.       resolve(null);
  463.     }
  464.   });
  465. };
  467. /**
  468.  * Returns the school weekly schedule.
  469.  * @async
  470.  * @function
  471.  * @param {SchoolData} school
  472.  * @param {namber} grade
  473.  * @param {namber} room
  474.  * @returns {?Array.<SchoolSchedule>}
  475.  */
  476. const getSchedules = (school, grade, room) => new Promise(async (resolve) => {
  477.   const data = await getComciganData(school);
  478.   if (data) {
  479.     const weeklySchedule = data.학급시간표[grade][room];
  480.     weeklySchedule[0] = null;
  481.     for (let day = 1; day < 6; day += 1) {
  482.       const schedule = weeklySchedule[day];
  483.       for (let period = 0, len2 = schedule.length; period < len2; period += 1) {
  484.         const subject = schedule[period];
  485.         if (subject > 100) {
  486.           weeklySchedule[day][period] = {
  487.             subject: data.과목명[subject % 100] || null,
  488.             subjectOriginal: data.긴과목명[subject % 100] || null,
  489.             teacher: data.성명[Math.floor(subject / 100)] || null,
  490.             isChanged: subject !== data.시간표[grade][room][day][period],
  491.           };
  492.         } else {
  493.           weeklySchedule[day][period] = null;
  494.         }
  495.       }
  496.       weeklySchedule[day].splice(0, 1);
  497.     }
  498.     weeklySchedule[6] = null;
  499.     resolve(weeklySchedule);
  500.   } else {
  501.     resolve(null);
  502.   }
  503. });
  505. /**
  506.  * Returns the school daily schedule.
  507.  * @async
  508.  * @function
  509.  * @param {SchoolData} school
  510.  * @param {number} grade
  511.  * @param {number} room
  512.  * @param {Date} date
  513.  * @returns {?SchoolSchedule}
  514.  */
  515. const getSchedule = (school, grade, room, date) => new Promise(async (resolve) => {
  516.   const schedules = await getSchedules(school, grade, room);
  517.   if (schedules) {
  518.     resolve(schedules[date.getDay()]);
  519.   } else {
  520.     resolve(null);
  521.   }
  522. });
  524. /**
  525.  * Returns the school teachers.
  526.  * @async
  527.  * @function
  528.  * @param {SchoolData} school
  529.  * @returns {?Array.<string>}
  530.  */
  531. const getTeachers = school => new Promise(async (resolve) => {
  532.   const data = await getComciganData(school);
  533.   if (data) {
  534.     resolve(data.성명.filter(value => value));
  535.   } else {
  536.     resolve(null);
  537.   }
  538. });
  540. /**
  541.  * Returns the school's teacher weekly schedule.
  542.  * @async
  543.  * @function
  544.  * @param {SchoolData} school
  545.  * @param {string} teacher
  546.  * @returns {?Array.<SchoolTeacherSchedule>}
  547.  */
  548. const getTeacherSchedules = (school, teacher) => new Promise(async (resolve) => {
  549.   const data = await getComciganData(school);
  550.   if (data) {
  551.     const teacherIndex = data.성명.indexOf(teacher);
  552.     if (teacherIndex >= 0) {
  553.       const weeklySchedule = data.교사시간표[teacherIndex];
  554.       weeklySchedule[0] = null;
  555.       for (let day = 1; day < 6; day += 1) {
  556.         const schedule = weeklySchedule[day];
  557.         for (let period = 0, len2 = schedule.length; period < len2; period += 1) {
  558.           const teacherData = schedule[period];
  559.           if (teacherData > 100) {
  560.             const tmp = Math.floor(teacherData / 100);
  561.             const grade = Math.floor(tmp / 100);
  562.             const room = tmp % 100;
  563.             const subject = data.시간표[grade][room][day][period] % 100;
  564.             weeklySchedule[day][period] = {
  565.               grade,
  566.               room,
  567.               subject: data.과목명[teacherData % 100] || null,
  568.               subjectOriginal: data.긴과목명[teacherData % 100] || null,
  569.               isChanged: teacherData !== (grade * 10000) + (room * 100) + subject,
  570.             };
  571.           } else {
  572.             weeklySchedule[day][period] = null;
  573.           }
  574.         }
  575.         weeklySchedule[day].splice(0, 1);
  576.       }
  577.       weeklySchedule[6] = null;
  578.       resolve(weeklySchedule);
  579.     } else {
  580.       resolve(null);
  581.     }
  582.   } else {
  583.     resolve(null);
  584.   }
  585. });
  587. /**
  588.  * Returns the school's teacher daily schedule.
  589.  * @async
  590.  * @function
  591.  * @param {SchoolData} school
  592.  * @param {string} teacher
  593.  * @param {Date} date
  594.  * @returns {?SchoolTeacherSchedule}
  595.  */
  596. const getTeacherSchedule = (school, teacher, date) => new Promise(async (resolve) => {
  597.   const schedules = await getTeacherSchedules(school, teacher);
  598.   if (schedules) {
  599.     resolve(schedules[date.getDay()]);
  600.   } else {
  601.     resolve(null);
  602.   }
  603. });
  605. exports.find = find;
  606. exports.findAll = findAll;
  607. exports.getAll = getAll;
  608. exports.getComciganData = getComciganData;
  609. exports.getInformation = getInformation;
  610. exports.getMeal = getMeal;
  611. exports.getMeals = getMeals;
  612. exports.getSchedule = getSchedule;
  613. exports.getSchedules = getSchedules;
  614. exports.getTeachers = getTeachers;
  615. exports.getTeacherSchedule = getTeacherSchedule;
  616. exports.getTeacherSchedules = getTeacherSchedules;