ViewController.swift

//  ViewController.swift
//  DataInputVoice
//
//  Created by Evgeny Veresov on 02.07.2017.
//  Copyright © 2017 Evgeny Veresov. All rights reserved.
//
//  Программа потокового ввода информации в базу данных с голоса.
//
//  1. Операционная система на устройстве ввода данных - iOS 10.
//  1. Преобразование голоса в текст выполняется на серверах Apple.
//  2. В качестве базы данных используются iCloud от Apple.
//  3. Работа с базой данных и преобразование голоса в текст
//     написаны по мотивам книги Neil Smyth "iOS 10 App Development Essentials".
//     Спасибо автору книги.
//  4. Идея и реализация программы голосового ввода в базу данных прнинадлежит мне.
//  5. Программа предоставляется "Как есть".
 
import UIKit
import Speech
import CloudKit
import UserNotifications
 
class ViewController: UIViewController, UNUserNotificationCenterDelegate  {
    
    // Переменные для базы данных
    let containerDatabase = CKContainer.default
    var privateDatabase: CKDatabase?
    var zoneDatabase: CKRecordZone?
    
    // Переменные для распознавания голоса
    let speechRecognizer = SFSpeechRecognizer(locale: Locale(identifier: "ru-RU"))!
    var speechRecognitionRequest:  SFSpeechAudioBufferRecognitionRequest?
    var speechRecognitionTask: SFSpeechRecognitionTask?
    let engine = AVAudioEngine()
    
    //Таймер для отсчета времени
    var timer: Timer!
    // Время работы трансляции
    var interval = 0
    // Признак окончания преобразования
    var flagStop = true
    // Текущий номер поля на форме
    var currentField = 0
    // Последнее распознанное слово
    var lastWord = ""
    // Прежнее значение счетчика буфера
    var oldCountBuffer = 0
    // Result String
    var resultInput = ""
    // Массив для resultInput
    var arrayBuffer:[String] = []
    
    // Переменные для оповещения
    var titleNotification       = ""
    var subtitleNotification    = ""
    var bodyNotification        = ""
    
    
    //  Кнопка записи в базу данных
    @IBOutlet weak var saveDatabase: UIBarButtonItem!
    @IBAction func selectSaveDatabase(_ sender: Any) {
        saveDatabase.isEnabled = false
        saveRecord()
        saveDatabase.isEnabled = true
        }
    
    
    // Кнопка поиска в базе данных
    @IBOutlet weak var findDatabase: UIBarButtonItem!
    @IBAction func selectFindDatabase(_ sender: Any) {
        findDatabase.isEnabled = false
        findRecord()
        findDatabase.isEnabled = true
        }
    
    
    // Кнопка обновления в базе данных
    @IBOutlet weak var updateDatabase: UIBarButtonItem!
    @IBAction func selectUpdateDatabase(_ sender: Any) {
        updateDatabase.isEnabled = false
        updateRecord()
        updateDatabase.isEnabled = true
        }
    
    
    // Кнопка удалентия записи
    @IBOutlet weak var deleteDatabase: UIBarButtonItem!
    @IBAction func selectDeleteDatabase(_ sender: Any) {
        deleteDatabase.isEnabled = false
        deleteRecord()
        deleteDatabase.isEnabled = true
        }
    
    // Кнопка Start
    @IBOutlet weak var transcribeButton: UIBarButtonItem!
    @IBAction func selectTranscribleButton(_ sender: Any) { runTranslation()}
    
    // Кнопка Stop
    @IBOutlet weak var stopButton: UIBarButtonItem!
    @IBAction func selectStopButton(_ sender: Any) {endTranslation()}
    
    
    // Поле Фамилия
    @IBOutlet weak var fam: UITextField!
    // Поле Имя
    @IBOutlet weak var im: UITextField!
    // Поле Отчество
    @IBOutlet weak var otch: UITextField!
    // Поле отчество
    @IBOutlet weak var dateBirth: UITextField!
    //Телефон
    @IBOutlet weak var phone: UITextField!
    // Таймер
    @IBOutlet weak var time: UITextField!
    
    // По загрузке
    override func viewDidLoad() {
        super.viewDidLoad()
        // Авторизация пользователя
        authorizeSR()
        // Разрешение на оповещения
        authorizeNotification()
        // Создадим private Database
        privateDatabase = containerDatabase().privateCloudDatabase
        // Создадим зону
        zoneDatabase = CKRecordZone(zoneName: "DataInputVoice")
        // Сохраним базу данных
        privateDatabase?.save(zoneDatabase!, completionHandler: {(recordzone, error) in
            if (error != nil) {
                DispatchQueue.main.async {self.notifyUser("Ошибка зоны", message: "Ошибка при создании зоны")}}
            else { print("Создана зона")}
        })
        
        // Начальное значение в поле телефон
        phone.text = "+7"
        // Создадим таймер
        createTimer()
    }
    
    
    // Сессия преобразования голоса в текст
    func startSession () throws {
        // Если задача преобразования уже запущена - остановим ее
        if let recognitionTask = speechRecognitionTask {
            recognitionTask.cancel()
            self.speechRecognitionTask = nil
        }
        // Создадим сессию
        let audioSession = AVAudioSession.sharedInstance()
        try audioSession.setCategory(AVAudioSessionCategoryRecord)
        // Создадим объект запроса
        speechRecognitionRequest = SFSpeechAudioBufferRecognitionRequest()
        // Если ошибка - выдадим сообщение
        guard let recognitionRequest = speechRecognitionRequest else {
            fatalError("Ошибка при создании SFSpeechAudioBufferRecognitionRequest") }
        // Создадим input node
        guard let inputNode = engine.inputNode else { fatalError("Не удалось создать input node") }
        // Установим признак выдавачи частичных результатов
        recognitionRequest.shouldReportPartialResults = true
        // Запустим задачу преобразования с обработчиком ответа преобразователя
        speechRecognitionTask = speechRecognizer.recognitionTask(with: recognitionRequest) { result, error in
            
            //Определим признак окончания времени
            var finished = false
            
            //  Считаем строку из преобразователя
            if  let result = result {
                self.resultInput = result.bestTranscription.formattedString
                // Считаем признак окончания работы
                finished = result.isFinal
            }
            // Если ошибка распознавания
            if error != nil {
                DispatchQueue.main.async {self.notifyUser("Распознавание речи", message: "Ошибка распознавания!")}
                self.flagStop = true
                
                self.engine.stop()
                inputNode.removeTap(onBus: 0)
                
                self.speechRecognitionRequest = nil
                self.speechRecognitionTask = nil
                
                self.transcribeButton.isEnabled = true
                self.stopButton.isEnabled = false
            }
            
            // Если истекло время перевода
            if finished {
                self.flagStop = true
                self.engine.stop()
                inputNode.removeTap(onBus: 0)
                
                self.speechRecognitionRequest = nil
                self.speechRecognitionTask = nil
                
                self.transcribeButton.isEnabled = true
                self.stopButton.isEnabled = false
            }
            
            //  Если все хорошо - начинаем анализ строки
            if (finished  != true && error == nil && self.flagStop == false) {
                // Переведем строку в массив
                self.arrayBuffer = self.resultInput.components(separatedBy: " ")
                // Перевод в нижний регистр последнего слова
                self.lastWord = self.arrayBuffer.last!.lowercased()
                
                // Если повторение слова
                if self.oldCountBuffer == self.arrayBuffer.count {
                    // Если команда - уходим
                    if (self.lastWord == "назад" || self.lastWord == "сохранить" || self.lastWord == "найти"
                        || self.lastWord == "обновить" || self.lastWord == "удалить") {return}
                    // Если слово для ввода - повторяем
                    if self.currentField > 0 {self.currentField -= 1}
                }
                
                // Разбор слова
                switch self.lastWord {
                // Команды работы с базой данных
                case "сохранить","записать": self.saveRecord()
                case "найти"    : self.findRecord()
                case "обновить" : self.updateRecord()
                case "удалить"  : self.deleteRecord()
                // Очистка всех полей
                case "стереть","обнулить","очистить"  : self.clearAll()
                // Очистка одного поля
                case "назад"    : self.clearField()
                // Команда окончания пееревода
                case "стоп"     : self.endTranslation()
                // Данные для ввода в поля
                default : self.translate(self.lastWord)
                    
                }
                // Запомним колличество слов в буффере
                self.oldCountBuffer = self.arrayBuffer.count
            }
        }
        // Определим формат преобразования
        let recordingFormat = inputNode.outputFormat(forBus: 0)
        inputNode.removeTap(onBus: 0)
        inputNode.installTap(onBus: 0, bufferSize: 1024, format: recordingFormat) { (buffer: AVAudioPCMBuffer, when: AVAudioTime) in
            self.speechRecognitionRequest?.append(buffer)
        }
        // Подготовим преобразователь
        engine.prepare()
        // Запустим
        try engine.start()
    }
    
    // Очистка текущего поля
    func clearField(){
        switch currentField {
        // Отмена однословных полей: фамилия, имя, отчество
        case 1 : fam.text   = ""
        case 2 : im.text    = ""
        case 3 : otch.text  = ""
        // Отмена даты рождения: число, месяц, год.
        case 4,5,6      : dateBirth.text = "";  currentField = 4
        case 7,8,9,10   : phone.text =   "+7 "; currentField = 7
        default : break
        }
        // Поднимаемся из стека в верх при удалении полей
        if currentField > 1 {currentField -= 1} else {currentField = 0}
    }
    
    // Функция заполнения полей формы при вводе с голоса
    func translate (_ lastWord: String) {
        // Определим текущую позицию в буфере
        let currentPositionBuffer  = arrayBuffer.count
        
        // Внимание! self.lastWord не переведена в нижний регистр
        // это предназначено для полей ФИО
        self.lastWord  = arrayBuffer[currentPositionBuffer - 1]
        
        // Опускаемся по стеку вниз
        if (currentField < 10 ) {currentField += 1} else {currentField = 1}
        switch currentField {
        case 1 : self.fam.text   = self.lastWord
        case 2 : self.im.text    = self.lastWord
        case 3 : self.otch.text  = self.lastWord;
        // Число
        case 4 : dateBirth.text  = lastWord
        // Месяц
        case 5 : dateBirth.text = arrayBuffer[currentPositionBuffer - 2] +  " " +
            arrayBuffer[currentPositionBuffer - 1]
        //Год
        case 6 : dateBirth.text  = arrayBuffer[currentPositionBuffer - 3] + "." +
            decoderMonth(arrayBuffer[currentPositionBuffer - 2]) + "." +
            String(arrayBuffer[currentPositionBuffer - 1].characters.prefix(4))
            
        // Проверим, что пришло число. Иначе ничего не вводим и уменьшаем счетчик поля на форме
        case 7 : if Int(lastWord) != nil {
            phone.text = "+7 " + lastWord}
        else {self.currentField -= 1; return}
            
        case 8 : if Int(lastWord) != nil{
            phone.text = "+7 " + arrayBuffer[currentPositionBuffer - 2] +  " " +
                arrayBuffer[currentPositionBuffer - 1]
        }
        else {self.currentField -= 1; return}
            
        case 9 : if Int(lastWord) != nil {
            phone.text = "+7 " + arrayBuffer[currentPositionBuffer - 3] +  " " +
                arrayBuffer[currentPositionBuffer - 2] + " " +
                arrayBuffer[currentPositionBuffer - 1]
        }
        else {self.currentField -= 1; return}
            
        case 10 : if Int(lastWord) != nil {
            phone.text = "+7 " + arrayBuffer[currentPositionBuffer - 4] +  " " +
                arrayBuffer[currentPositionBuffer - 3] + " " +
                arrayBuffer[currentPositionBuffer - 2] + " " +
                arrayBuffer[currentPositionBuffer - 1]
        }
        else {self.currentField -= 1; return}
        default : break
        }
    }
    
    // Функция сохранения записи в базе данных
    func saveRecord() {
        //Остановим переобразование
        endTranslation()       
        // Проверим на заполняемость ФИО
        if !checkFullPredicate() {return}     
        // Определим имя записи
        let record = CKRecord(recordType: "DataInputFromVoice", zoneID: (zoneDatabase?.zoneID)!)
        // Присвоим значения полям записи (Field in Row)
        record.setObject(fam.text   as CKRecordValue?,  forKey: "fam")
        record.setObject(im.text    as CKRecordValue?,  forKey: "im")
        record.setObject(otch.text  as CKRecordValue?,  forKey: "otch")
        record.setObject(dateBirth.text    as CKRecordValue?,  forKey: "dateBirth")
        record.setObject(phone.text  as CKRecordValue?,  forKey: "phone")
        // Определим метод записи в базу данных
        let modifyRecords = CKModifyRecordsOperation (recordsToSave: [record],recordIDsToDelete: nil)
        // Определим timeout для операции записи
        modifyRecords.timeoutIntervalForRequest  = 10
        // Определим обработчик записи
        modifyRecords.modifyRecordsCompletionBlock =
            { records, recordIDs, error in
                if let err = error {
                    DispatchQueue.main.async {self.notifyUser("Ошибка записи", message: err.localizedDescription)}}
                else {
                    DispatchQueue.main.async {
                        self.titleNotification      =   "Save record"
                        self.subtitleNotification   =    self.fam.text! + " "  + self.im.text!
                        self.bodyNotification       =   "Запись сохранена"
                        self.clearAll()
                        self.sendNotificationSave()
                        self.selectTranscribleButton("")
                    }
                }
        }
        // Запустим операцию
        privateDatabase?.add(modifyRecords)
    }
    
    
    //функция поиска записи в базе данных
    func findRecord() {
        //Остановим переобразование
        endTranslation()
       // Проверим на заполняемость ФИО
        if !checkFullPredicate() {return}
 
        // Сформируем поисковы образ
        let predicate = NSPredicate(format: "fam = %@ AND im = %@ AND otch = %@" , self.fam.text!, self.im.text!, self.otch.text!)
        // Сформируем запрос к базе данных
        let query = CKQuery(recordType: "DataInputFromVoice", predicate: predicate)
        // Выполним зпрос
        privateDatabase?.perform(query, inZoneWith: zoneDatabase?.zoneID, completionHandler: ({results, error in
            // Проверка результатов запроса
            // Если ошибка - выведем сообщение пользователю
            if (error != nil) {DispatchQueue.main.async {self.notifyUser("Ошибка поиска",message: error!.localizedDescription)}}
            else {
                // Если нашли записи - выведем первую в поля фоормы
                if results!.count > 0 {
                    let record = results![0]
                    //  Выведем запись на форму
                    DispatchQueue.main.async {
                        self.fam.text   = record.object(forKey: "fam")    as? String
                        self.im.text    = record.object(forKey: "im")     as? String
                        self.otch.text  = record.object(forKey: "otch")   as? String
                        self.dateBirth.text = record.object(forKey: "dateBirth")     as? String
                        self.phone.text = record.object(forKey: "phone")   as? String
                        self.notifyUser("Поиск записи", message: "Запись найдена!")
                        self.currentField = 10
                    }
                    // Если найденных записей нет - сообщим пользователю
                } else {DispatchQueue.main.async {self.notifyUser("Поиск записи", message: "Запись не найдена!")}}
            }
        }))
    }
    
    
    // Функция обновления записи
    func updateRecord(){
        //Остановим переобразование
        endTranslation()
        // Проверим на заполняемость ФИО
        if !checkFullPredicate() {return}
        // Сформируем поисковы образ
        let predicate = NSPredicate(format: "fam = %@ AND im = %@ AND otch = %@" , self.fam.text!, self.im.text!, self.otch.text!)
        // Сформируем запрос к базе данных
        let query = CKQuery(recordType: "DataInputFromVoice", predicate: predicate)
        // Выполним  поиск
        privateDatabase?.perform(query, inZoneWith: zoneDatabase?.zoneID, completionHandler:
            ({results, error in
                // Проверка результатов запроса
                // Если ошибка - выведем сообщение пользователю
                if (error != nil) {DispatchQueue.main.async {self.notifyUser("Ошибка поиска",message: error!.localizedDescription)}}
                else {
                    // Если нашли записи
                    if results!.count > 0 {
                        let record = results![0]
                        record.setObject(self.fam.text       as CKRecordValue?, forKey: "fam")
                        record.setObject(self.im.text        as CKRecordValue?, forKey: "im")
                        record.setObject(self.otch.text      as CKRecordValue?, forKey: "otch")
                        record.setObject(self.dateBirth.text as CKRecordValue?, forKey: "dateBirth")
                        record.setObject(self.phone.text     as CKRecordValue?, forKey: "phone")
                        // Запишем в базу данных
                        self.privateDatabase?.save(record, completionHandler:({returnRecord, error in
                            if let err = error {DispatchQueue.main.async {self.notifyUser("Ошибка обновления", message: err.localizedDescription)}
                            }
                            else {
                                 DispatchQueue.main.async {self.notifyUser("Обновление", message:"Запись обновлена")}
                                }
                            }))
 
                    } 
                    else {DispatchQueue.main.async {self.notifyUser("Обновление записи", message:"Запись не найдена")}}
                }
            }))
        }
 
    
    // Фукнция удаления записи
    func deleteRecord() {
        //Остановим переобразование
        endTranslation()
        // Проверим на заполняемость ФИО
        if !checkFullPredicate() {return}
        // Сформируем поисковы образ
        let predicate = NSPredicate(format: "fam = %@ AND im = %@ AND otch = %@" , self.fam.text!, self.im.text!, self.otch.text!)
        // Сформируем запрос к базе данных
        let query = CKQuery(recordType: "DataInputFromVoice", predicate: predicate)
        // Выполним  поиск
        privateDatabase?.perform(query, inZoneWith: zoneDatabase?.zoneID, completionHandler:
            ({results, error in
                // Проверка результатов запроса
                // Если ошибка - выведем сообщение пользователю
                if (error != nil) {DispatchQueue.main.async {self.notifyUser("Ошибка поиска",message: error!.localizedDescription)}}
                else {
                    // Если нашли записи
                    if results!.count > 0 {
                        let record = results![0]
                        // Удалим запись
                        self.privateDatabase?.delete(withRecordID: record.recordID, completionHandler: ({returnRecord, error in
                            if let err = error {DispatchQueue.main.async {self.notifyUser("Ошибка удаления", message: err.localizedDescription)}}
                            else {
                                DispatchQueue.main.async {
                                    self.notifyUser("Удаление записи", message: "Запись удалена")
                                    self.clearAll()
                                    }
                                }
                        }))
                       }
                    // Если найденных записей нет - сообщим пользователю
                    else {DispatchQueue.main.async {self.notifyUser("Удаление записи", message: "Запись не найдена!")}}
                }
        }))
    }
    
    // Создание таймера
    func createTimer(){
        timer = Timer.scheduledTimer(timeInterval: 1, target:self, selector: (#selector(ViewController.updateTimer)),
                                     userInfo: nil, repeats: true)
    }
    
    
    // Обновление таймера через секунду
    func updateTimer() {
        // Если флага останова трансляции нет - считаем
        if flagStop == false {
            if interval <= 60 {
                time.text = String(60 - interval)
                interval = interval + 1
            }
          //  print(String(format: "%02i", interval))
        }
    }
    
    // Запуск перевода
    func runTranslation() {
        print("Start")
        flagStop = false
        try! startSession()
        interval = 0
        transcribeButton.isEnabled = false
        stopButton.isEnabled = true
            }
    
    // Остановка преобразования
    func endTranslation() {
        // Установим флаг конца преобразования
        flagStop = true
        
        // Если преобразование запущено - остановим
        if engine.isRunning {
            print("Finished")
            engine.stop()
            speechRecognitionRequest?.endAudio()
        }
        
        // Установка видимости кнопок старт/стоп
        transcribeButton.isEnabled = true
        stopButton.isEnabled = false
        time.text = String(0)
    }
    
    // Функция декодирования месяца в цифры
    func decoderMonth(_ month:String) -> String {
        // Выделим три символа
        let predicate = String(month.characters.prefix(3)).lowercased()
       // print(predicate)
        switch predicate {
        case "янв": return "01"
        case "фев": return "02"
        case "мар": return "03"
        case "апр": return "04"
        case "мая","май": return "05"
        case "июн": return "06"
        case "июл": return "07"
        case "авг": return "08"
        case "сен": return "09"
        case "окт": return "10"
        case "ноя": return "11"
        case "дек": return "12"
        default: return ""
        }
    }
    
    // Проверка заполняемости полей
    func checkFullPredicate() -> Bool {
        if  (fam.text! == "" || im.text! == "" || otch.text! == "" ) {
            notifyUser("Поисковый образ", message: "Заполните поля формы ФИО!")
            return false
        }
        else
        {return true}
    }

 
    // Очистка всех полей на форме
    func clearAll() {
        fam.text    = ""
        im.text     = ""
        otch.text   = ""
        dateBirth.text   = ""
        phone.text  = ""
        currentField = 0
    }
    
    // Функцмя закрытия клавиатуры по окончании редактирования
    override func touchesBegan(_ touches: Set<UITouch>, with event: UIEvent?) {
        fam.endEditing(true)
        im.endEditing(true)
        otch.endEditing(true)
        dateBirth.endEditing(true)
        phone.endEditing(true)
    }
    
    // Функция освобождения ресурсов
    override func didReceiveMemoryWarning() {
        super.didReceiveMemoryWarning()
        timer.invalidate()
    }
    
    
    // Ооповещения пользователя с запуском трансляции
    func notifyUser(_ title: String, message: String) -> Void {
        let alert = UIAlertController(title: title, message: message, preferredStyle: .alert)
        let cancelAction = UIAlertAction(title: "OK", style: .cancel,
                                         handler: {(action) -> Void in self.selectTranscribleButton("")})
        alert.addAction(cancelAction)
        self.present(alert, animated: true, completion: nil)
    }
    
    // Функция авторизации
    func authorizeSR() {
        SFSpeechRecognizer.requestAuthorization { authStatus in
            OperationQueue.main.addOperation {
                switch authStatus {
                case .authorized:
                    self.transcribeButton.isEnabled = true
                case .denied:
                    self.transcribeButton.isEnabled = false
                case .restricted:
                    self.transcribeButton.isEnabled = false
                case .notDetermined:
                    self.transcribeButton.isEnabled = false
                }
            }
        }
    }
    
    // Авторизация на выдачу оповещений
    func authorizeNotification(){
        UNUserNotificationCenter.current().requestAuthorization(options:
            [[.alert, .sound, .badge]], completionHandler: { (granted, error) in  })
        UNUserNotificationCenter.current().delegate = self
    }
    
    // Функция оповещения
    func sendNotificationSave() {
        let content = UNMutableNotificationContent()
        content.title       = titleNotification
        content.subtitle    = subtitleNotification
        content.body        = bodyNotification
        content.badge = 1
        let trigger = UNTimeIntervalNotificationTrigger(timeInterval: 1, repeats: false)
        let requestIdentifier = "01/08/2017"
        let request = UNNotificationRequest(identifier: requestIdentifier,  content: content, trigger: trigger)
        UNUserNotificationCenter.current().add(request,  withCompletionHandler: { (error) in
            if error != nil { print ("error + \(error.debugDescription)")} })
    }
    
    // Вызов оповещения
    func userNotificationCenter(_ center: UNUserNotificationCenter, willPresent notification: UNNotification,withCompletionHandler completionHandler: @escaping (UNNotificationPresentationOptions) -> Void) {
        completionHandler([.alert, .sound])
    }
    
}